Sign in
tasks

List tasks

List background tasks for the authenticated user with optional filtering.

Results are ordered newest first. Returns 404 when library_id names a library that does not exist or is not accessible to the authenticated user.

get/api/tasks/

Query parameters

library_idstring nullable

Restrict results to tasks owned by this library. When omitted, returns tasks across every library the authenticated user owns.

Restrict results to tasks owned by this library. When omitted, returns tasks across every library the authenticated user owns.

status'pending' | 'started' | 'success' | 'failure'

Status of a background task execution: pending (created and awaiting processing), started (picked up by a worker and not yet in a terminal state — the task may be executing or awaiting an automatic retry after a transient failure), success (completed successfully), or failure (failed and will not be retried).

Return only tasks currently in this execution status.

task_type'image_quality' | 'embedding' | 'face_detection' | 'face_clustering' | 'asset_description' | 'asset_storage_cleanup' | 'asset_version_storage_cleanup' | 'reverse_geocoding' | 'video_thumbnail_extract' | 'video_metadata_extract' | 'thumbhash' | 'display_proxy_generation' | 'burst_detection' | 'product_update_subscription'

Kind of background processing a task performs: image_quality (historical only — scored an image's technical quality; this task type is retired and no longer dispatched, the value appears only on old task rows), embedding (compute the content embedding that powers search), face_detection (detect faces in an asset), face_clustering (group a library's detected faces into people), asset_description (generate a natural-language description of an asset), asset_storage_cleanup (remove stored files left behind by a permanently deleted asset), asset_version_storage_cleanup (remove stored files of a superseded asset version), reverse_geocoding (resolve an asset's GPS coordinates to a place name), video_thumbnail_extract (extract a thumbnail image from a video), video_metadata_extract (recover a video's capture time, GPS location, and camera details from the file's own metadata), thumbhash (compute the blurred placeholder shown while a thumbnail loads), display_proxy_generation (generate a browser-displayable rendition of an original the image CDN cannot transform, such as an oversized or over-dimensioned file), burst_detection (detect rapid-fire shots of the same moment and stack them), or product_update_subscription (enroll an explicitly opted-in new user in product-update email delivery).

Return only tasks of this type.

limitinteger

Maximum number of tasks to return.

Maximum number of tasks to return.

Response

Successful Response

idstring required

Unique task identifier with btask_ prefix

asset_idstring nullable required

ID of the asset this task processes; null for library-scoped tasks such as face clustering

task_type'image_quality' | 'embedding' | 'face_detection' | 'face_clustering' | 'asset_description' | 'asset_storage_cleanup' | 'asset_version_storage_cleanup' | 'reverse_geocoding' | 'video_thumbnail_extract' | 'video_metadata_extract' | 'thumbhash' | 'display_proxy_generation' | 'burst_detection' | 'product_update_subscription' required

Kind of background processing a task performs: image_quality (historical only — scored an image's technical quality; this task type is retired and no longer dispatched, the value appears only on old task rows), embedding (compute the content embedding that powers search), face_detection (detect faces in an asset), face_clustering (group a library's detected faces into people), asset_description (generate a natural-language description of an asset), asset_storage_cleanup (remove stored files left behind by a permanently deleted asset), asset_version_storage_cleanup (remove stored files of a superseded asset version), reverse_geocoding (resolve an asset's GPS coordinates to a place name), video_thumbnail_extract (extract a thumbnail image from a video), video_metadata_extract (recover a video's capture time, GPS location, and camera details from the file's own metadata), thumbhash (compute the blurred placeholder shown while a thumbnail loads), display_proxy_generation (generate a browser-displayable rendition of an original the image CDN cannot transform, such as an oversized or over-dimensioned file), burst_detection (detect rapid-fire shots of the same moment and stack them), or product_update_subscription (enroll an explicitly opted-in new user in product-update email delivery).

celery_task_idstring required

Application-generated delivery identifier supplied to the task queue. Also accepted by get_task_status in place of id.

status'pending' | 'started' | 'success' | 'failure' required

Status of a background task execution: pending (created and awaiting processing), started (picked up by a worker and not yet in a terminal state — the task may be executing or awaiting an automatic retry after a transient failure), success (completed successfully), or failure (failed and will not be retried).

resultstring nullable required

Result summary produced by a completed task; null until success

error_messagestring nullable required

Error detail from the most recent failed or retried attempt; not cleared by a later success, so it can be non-null on a task that failed transiently and then succeeded. Null if no attempt has failed

retry_countinteger required

Retry and rescue bookkeeping value for this task. Zero before any automatic retry or stuck-task rescue; not guaranteed to be a cumulative delivery count

created_atstring required

When the task record was created (ISO 8601); dispatch to the task queue follows separately, after the creating transaction commits

started_atstring nullable required

When a worker most recently began executing the task, or when the stuck-task reaper rescued it back to pending (ISO 8601). Because a rescue can re-enqueue a task no worker ever picked up, a non-null value does not prove a worker has run the task

completed_atstring nullable required

When the task finished, whether successfully or not (ISO 8601); null until then

Changes

Changed in 11 of the 79 revisions of this API.1714

  • cd15387eb36511See the full diff
    • ●

      added the new product_update_subscription enum value to the items/task_type response property for the response status 200

      response-property-enum-value-added

    • ○

      added the enum value product_update_subscription to the property anyOf[subschema #1: TaskType]/ of the query request parameter task_type

      request-parameter-property-enum-value-added

  • 815e0302a98811See the full diff
    • ▲

      response property detail list-of-types was widened by adding types string to media type application/json of response 422

      response-property-list-of-types-widened

    • ○

      the response property detail became required for the status 422

      response-property-became-required

  • c3e15c78f2da4See the full diff
    • ○

      added the non-success response with the status 401

      response-non-success-status-added

    • ○

      added the non-success response with the status 403

      response-non-success-status-added

    • ○

      added the non-success response with the status 404

      response-non-success-status-added

    • ○

      added the non-success response with the status 429

      response-non-success-status-added

  • 6397cb5a99c51See the full diff
    • ○

      api operation id list_tasks_api_tasks__get removed and replaced with list_tasks

      api-operation-id-removed

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • ad26f9fc366511See the full diff
    • ●

      added the new asset_version_storage_cleanup enum value to the items/task_type response property for the response status 200

      response-property-enum-value-added

    • ○

      added the enum value asset_version_storage_cleanup to the property anyOf[subschema #1: TaskType]/ of the query request parameter task_type

      request-parameter-property-enum-value-added

  • 5eca0ee5157111See the full diff
    • ●

      added the new burst_detection enum value to the items/task_type response property for the response status 200

      response-property-enum-value-added

    • ○

      added the enum value burst_detection to the property anyOf[subschema #1: TaskType]/ of the query request parameter task_type

      request-parameter-property-enum-value-added

  • 93d4227fb66d11See the full diff
    • ●

      added the new display_proxy_generation enum value to the items/task_type response property for the response status 200

      response-property-enum-value-added

    • ○

      added the enum value display_proxy_generation to the property anyOf[subschema #1: TaskType]/ of the query request parameter task_type

      request-parameter-property-enum-value-added

  • 477eebb078d511See the full diff
    • ●

      added the new video_metadata_extract enum value to the items/task_type response property for the response status 200

      response-property-enum-value-added

    • ○

      added the enum value video_metadata_extract to the property anyOf[subschema #1: TaskType]/ of the query request parameter task_type

      request-parameter-property-enum-value-added

  • 944dd780e16111See the full diff
    • ●

      added the new thumbhash enum value to the items/task_type response property for the response status 200

      response-property-enum-value-added

    • ○

      added the enum value thumbhash to the property anyOf[subschema #1: TaskType]/ of the query request parameter task_type

      request-parameter-property-enum-value-added

  • 482f29942d7311See the full diff
    • ●

      added the new video_thumbnail_extract enum value to the items/task_type response property for the response status 200

      response-property-enum-value-added

    • ○

      added the enum value video_thumbnail_extract to the property anyOf[subschema #1: TaskType]/ of the query request parameter task_type

      request-parameter-property-enum-value-added