Skip to main content
POST
Create a new task

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
client-id
string<uuid>
required

Unique identifier for the client

campaign-id
string
required

Identifier for the campaign

template-id
string<uuid>
required

Unique identifier for the template to use

file-name
string
required

Name of the file to process

file-path
string
required

S3 path to the input file

priority
integer
required

Task priority level

row-count
integer

Number of rows to process

Required range: x >= 1
expected-output-duration
integer

Expected duration for output generation (in minutes)

Required range: x >= 1

Response

200 - application/json

Task created successfully

client-id
string<uuid>

Unique identifier for the client

campaign-id
string

Identifier for the campaign

template-id
string<uuid>

Unique identifier for the template to use

task-id
string<uuid>

Unique identifier for the created task

message
string

Task created successfully