Skip to main content
POST
/
v1
/
queue
/
add
Add video generation request to the queue
curl --request POST \
  --url https://api.example.com/v1/queue/add \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "projectId": "<string>",
  "overwriteSettings": true,
  "customPrompt": "<string>"
}
'
{
  "status": "<string>",
  "message": "<string>",
  "newQueueItem": {
    "queueId": "<string>",
    "projectId": "<string>",
    "status": "<string>",
    "generationProgress": 123,
    "renderProgress": 123,
    "videoUrl": "<string>",
    "createdAt": "2023-11-07T05:31:56Z"
  }
}
Very Important: This operation will use your account credits. Each video generated will reduce your credits. Most videos cost 1 credit, but not always, it depends on your chosen project settings, please proceed with caution.

Authorizations

​
Authorization
string
header
required

Use format Bearer YOUR_API_KEY.

Body

application/json
​
projectId
string
required
​
overwriteSettings
boolean
​
customPrompt
string | null

Response

Video generation request added successfully

​
status
string
​
message
string
​
newQueueItem
object