Skip to main content
POST
/
2
/
tasks
/
{taskID}
/
run
curl
curl --request POST \
  --url https://data.us.algolia.com/2/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":{}}'
{
  "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.

Example:

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

Body

application/json
​
runMetadata
object

Additional information that will be passed to the created run.

Response

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.

⌘I