Skip to main content
POST
Veo 3.1

Pricing

Fixed API prices in USD.
These aliases are accepted for compatibility only and are not shown in the request schema.

Authorizations

Authorization
string
header
required

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

Headers

X-Webhook-URL
string<uri>

URL to receive a POST request when the job completes. The webhook will receive the job data including results.

Body

application/json
prompt
string
required
start_image
string<uri> | null

Can be an external URL, base64 data URI, or uploaded asset URL.

Maximum string length: 1024
aspect_ratio
enum<string>
default:16:9
Available options:
16:9,
9:16
duration
default:8
Available options:
TitleConst
Unknown4
Unknown6
Unknown8
generate_audio
boolean
default:false
resolution
enum<string>
default:720p
Available options:
720p,
1080p,
4K
end_image
string<uri> | null

Can be an external URL, base64 data URI, or uploaded asset URL.

Maximum string length: 1024
reference_images
string<uri>[]

Can be an external URL, base64 data URI, or uploaded asset URL.

Maximum string length: 1024

Response

The resulting job data. This will be returned in a pending state until the job is completed. See /jobs/{id} for retrieving the results.

job_id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
status
enum<string>
required
Available options:
backlogged,
queued,
scheduled,
processing,
sampling,
intermediate-complete,
completed,
failed,
cancelled
created_at
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
completed_at
null
required
result
null
required
error
object