Run a task V1

Runs a task using the v1 endpoint, please use runTask instead. You can check the status of task runs with the observability endpoints.

POST /1/tasks/{taskID}/run

curl

cURL

curl --request POST \
  --url https://data.us.algolia.com/1/tasks/6c02aeb1-775e-418e-870b-1faccd4b2c0f/run \
  --header 'accept: application/json' \
  --header 'content-type: application/json' \
  --header 'x-algolia-api-key: ALGOLIA_API_KEY' \
  --header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID' \
  --data '{"runMetadata":{}}'

200

{
  "runID": "6c02aeb1-775e-418e-870b-1faccd4b2c0f",
  "createdAt": "<string>"
}

Required ACL: addObject, deleteIndex, editSettings

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

taskID · string · required

Unique identifier of a task. Universally unique identifier (UUID) of a task.

Example:

"6c02aeb1-775e-418e-870b-1faccd4b2c0f"

Body

application/json

runMetadata · object

Additional information that will be passed to the created run.

Response

200

application/json

OK

API response for running a task.

runID · string · required

Universally unique identifier (UUID) of a task run.

Example:

"6c02aeb1-775e-418e-870b-1faccd4b2c0f"

createdAt · string · required

Date of creation in RFC 3339 format.