Video

AI video generation (scripts, generation, status)

Generate video script

post

Generate a detailed video prompt and settings from a brief description.

Authorizations

ApiKeyAuth

X-API-KEYstringRequired

Body

application/json

briefstringRequired

Brief description of the video

formatstring · enumOptionalPossible values:

platformstringOptional

site_idstring · uuidOptional

Responses

200

Generated video script

application/json

promptstringOptional

suggested_durationnumberOptional

suggested_aspect_ratiostringOptional

suggested_resolutionstringOptional

shot_descriptionstringOptional

negative_promptstringOptional

post

/v1/video/script

HTTPcURLJavaScriptPython

POST /v1/video/script HTTP/1.1
Host: api.cuppa.ai
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 111

{
  "brief": "text",
  "format": "product_showcase",
  "platform": "text",
  "site_id": "123e4567-e89b-12d3-a456-426614174000"
}

200

Generated video script

{
  "prompt": "text",
  "suggested_duration": 1,
  "suggested_aspect_ratio": "text",
  "suggested_resolution": "text",
  "shot_description": "text",
  "negative_prompt": "text"
}

Create video generation job

post

Start a video generation job. Returns an ID to poll for status.

Authorizations

ApiKeyAuth

X-API-KEYstringRequired

Body

application/json

promptstringRequired

modelstringRequired

Video model to use (e.g. sora-2, replicate:p-video, replicate:kling-v2.6)

duration_secondsnumberRequired

aspect_ratiostring · enumOptionalPossible values:

resolutionstring · enumOptionalPossible values:

negative_promptstringOptional

site_idstring · uuidOptional

use_brand_contextbooleanOptional

Responses

201

Video generation job created

application/json

post

/v1/video

HTTPcURLJavaScriptPython

POST /v1/video HTTP/1.1
Host: api.cuppa.ai
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 194

{
  "prompt": "text",
  "model": "text",
  "duration_seconds": 1,
  "aspect_ratio": "16:9",
  "resolution": "480p",
  "negative_prompt": "text",
  "site_id": "123e4567-e89b-12d3-a456-426614174000",
  "use_brand_context": true
}

201

Video generation job created

{
  "id": "text",
  "status": "progress"
}

Get video status

get

Check the status of a video generation job.

Authorizations

ApiKeyAuth

X-API-KEYstringRequired

Path parameters

idstringRequired

Video job ID

Responses

200

Video job status

application/json

idstringOptional

urlstring · nullableOptional

thumbnail_urlstring · nullableOptional

statusstringOptional

providerstring · nullableOptional

modelstring · nullableOptional

video_typestring · nullableOptional

metaobject · nullableOptional

progressnumber · nullableOptional

duration_secondsnumber · nullableOptional

error_messagestring · nullableOptional

created_atstring · date-timeOptional

get

/v1/video/{id}

HTTPcURLJavaScriptPython

GET /v1/video/{id} HTTP/1.1
Host: api.cuppa.ai
X-API-KEY: YOUR_API_KEY
Accept: */*

200

Video job status

{
  "id": "text",
  "url": "text",
  "thumbnail_url": "text",
  "status": "text",
  "provider": "text",
  "model": "text",
  "video_type": "text",
  "meta": {},
  "progress": 1,
  "duration_seconds": 1,
  "error_message": "text",
  "created_at": "2026-03-14T14:06:32.528Z"
}

Delete video

delete

Authorizations

ApiKeyAuth

X-API-KEYstringRequired

Path parameters

idstringRequired

Video job ID

Responses

200

Video deleted

application/json

deletedbooleanOptional

delete

/v1/video/{id}

HTTPcURLJavaScriptPython

DELETE /v1/video/{id} HTTP/1.1
Host: api.cuppa.ai
X-API-KEY: YOUR_API_KEY
Accept: */*

200

Video deleted

{
  "deleted": true
}