Get collection async task

GET 
/openapi/2027-01/collections/async-task/:id

Retrieves the status and result of an asynchronous collection task initiated by AsyncCreateCollection or AsyncUpdateSmartCollectionRule.

Request

Path Parameters

id stringrequired

Async task ID returned by AsyncCreateCollection or AsyncUpdateSmartCollectionRule

Query Parameters

source_id string

Source resource ID this task operates on (e.g. collection UUID). Used as an alternative lookup key together with task_type when async task ID is unknown

task_type string
Task type. Allowed values:
• create_collection: async smart collection creation
• update_smart_collection_rule: async smart collection rule update

Responses

200

OK

application/json

Schema

Schema

codestring

error code

messagestring

error message

data object

async_task object

Async task detail

idstring

Async task ID

source_idstring

Source resource ID this task operates on (e.g. collection UUID)

task_typestring

Task type. Possible values: create_collection, update_smart_collection_rule

statestring

Task state. Possible values: pending, running, succeeded, failed

messagestring

Human-readable message, typically an error description when state = failed

created_atstring

Task creation time, ISO 8601 format (e.g. 2026-01-15T10:30:00Z)

updated_atstring

Task last update time, ISO 8601 format

task_data object

Task payload. Concrete schema depends on task_type. The wrapped message includes its @type for client-side decoding

@typestring

The type of the serialized message.

property name*any

Task payload. Concrete schema depends on task_type. The wrapped message includes its @type for client-side decoding

Example

json

{
  "code": "string",
  "message": "string",
  "data": {
    "async_task": {
      "id": "string",
      "source_id": "string",
      "task_type": "string",
      "state": "string",
      "message": "string",
      "created_at": "string",
      "updated_at": "string",
      "task_data": {
        "@type": "string"
      }
    }
  }
}