Skip to main content
POST
List Tasks

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit
integer | null
Required range: 1 <= x <= 1000
page_size
integer | null
Required range: 1 <= x <= 1000
offset
integer | null
Required range: 0 <= x <= 10000
page
integer | null
Required range: x >= 1
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,
QUEUED,
IN_PROGRESS,
PROCESSING,
COMPLETED,
COMPLETED_WITH_ERRORS,
FAILED,
CANCELED,
INTERRUPTED,
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_snapshot_create,
api_namespaces_snapshot_restore,
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,
api_collections_export,
api_collections_trigger,
engine_feature_extractor_run,
engine_inference_run,
engine_object_processing,
engine_cluster_build,
thumbnail,
video_segment,
audio_segment,
converted_video,
materialize,
plugin_custom,
model_custom
filters
LogicalOperator · object | null

Advanced filters to apply.

sort
SortOption · object | null

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