Create a task V1

curl --request POST \ --url https://data.us.algolia.com/1/tasks \ --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 ' { "sourceID": "6c02aeb1-775e-418e-870b-1faccd4b2c0f", "destinationID": "6c02aeb1-775e-418e-870b-1faccd4b2c0f", "trigger": { "type": "onDemand" }, "action": "replace", "enabled": true, "failureThreshold": 0, "input": { "mapping": { "format": "mappingkit/v1", "actions": [ { "id": "lorem", "enabled": true, "trigger": "lorem", "fieldDirectives": [ { "fieldKey": "lorem", "value": {} } ] } ] } }, "cursor": "lorem" } '

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.

Body

application/json

Request body for creating a task.

API request body for creating a task using the V1 shape. Use methods and types that don't contain the V1 suffix.

action

enum<string>

required

Action to perform on the Algolia index.

Available options:

replace,

save,

partial,

partialNoCreate,

append

destinationID

string

required

Universally unique identifier (UUID) of a destination resource.

Example:

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

sourceID

string

required

Universally uniqud identifier (UUID) of a source.

Example:

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

trigger

object

required

Trigger information for manually-triggered tasks.

Option 1
Option 2
Option 3
Option 4

Show child attributes

cursor

string

Date and time when the last cursor was created, in RFC 3339 format.

enabled

boolean

Whether the task is enabled.

failureThreshold

integer

Maximum accepted percentage of failures for a task run to finish successfully.

Required range: 0 <= x <= 100

input

Streaming input · object

Configuration of the task, depending on its type.

Streaming input
Docker streams
Shopify input

Show child attributes

Response

API response for creating a task.

createdAt

string

required

Date and time when the resource was created, in RFC 3339 format.

taskID

string

required

Universally unique identifier (UUID) of a task.

Example:

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