Skip to main content
POST
/
v1
/
tasks
/
list
List Tasks
curl --request POST \
  --url https://api.mixpeek.com/v1/tasks/list \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "PENDING",
  "task_type": "api_namespaces_create",
  "filters": {
    "AND": [
      {
        "field": "name",
        "operator": "eq",
        "value": "John"
      },
      {
        "field": "age",
        "operator": "gte",
        "value": 30
      }
    ],
    "OR": [
      {
        "field": "status",
        "operator": "eq",
        "value": "active"
      },
      {
        "field": "role",
        "operator": "eq",
        "value": "admin"
      }
    ],
    "NOT": [
      {
        "field": "department",
        "operator": "eq",
        "value": "HR"
      },
      {
        "field": "location",
        "operator": "eq",
        "value": "remote"
      }
    ],
    "case_sensitive": true
  },
  "sort": {
    "field": "created_at",
    "direction": "desc"
  },
  "search": "<string>"
}
'
{
  "results": [
    {
      "task_id": "<string>",
      "task_type": "api_namespaces_create",
      "status": "PENDING",
      "inputs": [
        "batch_xyz789"
      ],
      "outputs": [
        "document_123",
        "document_456"
      ],
      "additional_data": {
        "batch_id": "btch_xyz789",
        "bucket_id": "bkt_products",
        "collection_ids": [
          "col_tier0",
          "col_tier1",
          "col_tier2"
        ],
        "current_tier": 1,
        "job_id": "ray_job_123",
        "namespace_id": "ns_abc123",
        "object_count": 10000,
        "sample_object_ids": [
          "obj_001",
          "obj_002",
          "obj_003",
          "obj_004",
          "obj_005"
        ],
        "total_tiers": 3
      },
      "error": "Failed to process batch: Object not found"
    }
  ],
  "pagination": {
    "total": 123,
    "page": 123,
    "page_size": 123,
    "total_pages": 123,
    "next_page": "<string>",
    "previous_page": "<string>",
    "next_cursor": "<string>"
  }
}

Headers

Authorization
string

REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings.

Examples:

"Bearer YOUR_API_KEY"

"Bearer YOUR_STRIPE_API_KEY"

Query Parameters

limit
integer | null
Required range: 1 <= x <= 1000
offset
integer | null
Required range: 0 <= x <= 10000
cursor
string | null
include_total
boolean
default:false

Body

application/json

Request model for listing tasks.

Filter tasks by status, type, or other criteria.

status
enum<string> | null

Filter by specific task status (PENDING, IN_PROGRESS, PROCESSING, COMPLETED, FAILED, CANCELED, etc.).

Available options:
PENDING,
IN_PROGRESS,
PROCESSING,
COMPLETED,
COMPLETED_WITH_ERRORS,
FAILED,
CANCELED,
UNKNOWN,
SKIPPED,
DRAFT,
ACTIVE,
ARCHIVED,
SUSPENDED
task_type
enum<string> | null

Filter by task type (e.g., API_BUCKETS_OBJECTS_CREATE, BATCH_CONFIRM, etc.)

Available options:
api_namespaces_create,
api_namespaces_delete,
api_namespaces_migrations_run,
api_buckets_objects_create,
api_buckets_delete,
api_buckets_batches_process,
api_buckets_batches_submit,
api_buckets_uploads_create,
api_buckets_uploads_confirm,
api_buckets_uploads_batch_confirm,
api_collections_documents_create,
api_collections_extraction_artifacts,
api_taxonomies_create,
api_taxonomies_execute,
api_taxonomies_materialize,
api_evaluations_run,
api_evaluations_dataset_create,
api_retrievers_publish,
engine_feature_extractor_run,
engine_inference_run,
engine_object_processing,
engine_cluster_build,
thumbnail,
video_segment,
audio_segment,
materialize,
plugin_custom
filters
LogicalOperator · object

Advanced filters to apply.

sort
SortOption · object

Sort options.

search
string | null

Search term.

Response

Successful Response

Response model for listing tasks.

results
TaskResponse · object[]
required
pagination
PaginationResponse · object
required

PaginationResponse.

Cursor-based pagination response:

  • Use next_cursor for navigation
  • Total count fields only populated when include_total=true