Skip to main content
POST
/
image
/
task
/
create
Create a new task
curl --request POST \
  --url https://whilter-api-host/image/task/create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "client-id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "campaign-id": "<string>",
  "template-id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "file-name": "<string>",
  "file-path": "<string>",
  "row-count": 2,
  "expected-output-duration": 2,
  "priority": 123
}'
{
  "client-id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "campaign-id": "<string>",
  "template-id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "task-id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "message": "<string>"
}

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