Skip to main content
POST
Create Batch

Authorizations

x-api-key
string
header
required

Body

multipart/form-data
batch_input_data
file
required

the path to a JSONL file containing objects with the format: { "data_uuid": string, "inputs": array }

task_id
string
required
task_version
number

Optional - Version number of the task to be executed. Will default to latest live version.

Example:

1

batch_name
string

Optional - Name for the batch job

Example:

"Research 001"

webhook_url
string

Optional - Webhook URL to receive results and success status on completion. Data will be sent as a POST request with the data under body.data as an array of objects.

Example:

"https://api.example.com/webhook/batch-results"

Response

Batch successfully created.

status
enum<string>
required
Available options:
success,
error
Example:

"success"

data
object[]
required
message
string
required
error
object