Check task status

curl --request GET \ --url https://algolia_application_id.algolia.net/1/compositions/my_composition_object_id/task/1506303845001 \ --header 'accept: application/json' \ --header 'x-algolia-api-key: ALGOLIA_API_KEY' \ --header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID'

Authorizations

x-algolia-application-id

string

header

required

Your Algolia application ID.

x-algolia-api-key

string

header

required

Your Algolia API key with the necessary permissions to make the request. Permissions are controlled through access control lists (ACL) and access restrictions. The required ACL to make a request is listed in each endpoint's reference.

Path Parameters

compositionID

string

required

Unique Composition ObjectID. Composition unique identifier.

Example:

"my_composition_object_id"

taskID

integer<int64>

required

Unique task identifier.

Example:

1506303845001

Response

status

enum<string>

required

Task status, published if the task is completed, notPublished otherwise.

Available options:

published,

notPublished