Authentication
authorization string required
All APIs require authentication via Bearer Token
Get API Key:
Visit API Key Management Page to get your API Key
Usage:
Add to request header:
Authorization: Bearer YOUR_API_KEY
Parameters
model string required
Model ID to use for the request
Value: veo_3.1_generate_001
prompt string required
Video generation prompt, length must be between 1-2000 characters
durationSeconds integer required
Video duration in seconds. Must be 4, 6 or 8
Note: Reference image to video only supports 8 seconds
Options: 4, 6, 8
Default: 8
generateAudio boolean required
Whether to generate audio for video. Veo 3 model requires this parameter
Note: generateAudio is not supported by veo-2.0-generate-001 or veo-2.0-generate-exp
aspectRatio string
Video aspect ratio
Note: Reference image to video excludes 9:16
Options: 9:16, 16:9
Default: 16:9
resolution string
Video resolution. Only for Veo 3 model
Note: Video extension ad excludes 1080p
Options: 720p, 1080p
Default: 720p
compressionQuality string
Compression quality
Options: optimized, lossless
Default: optimized
personGeneration string
Person generation settings, for controlling whether to allow person or face generation
Options:
allow_adult: Only allow generation of adults (default)dont_allow: Prohibit containing persons/faces in image
Default: allow_adult
sampleCount integer
Generation sample count, request output video quantity
Range: 1 - 4
Default: 1
seed integer
Random seed, to make generation video deterministic. Adding seed number in request without changing other parameters will cause model to generate same video
Range: 0 - 4294967295
negativePrompt string
Negative prompt, for describing content you want to prevent model from generating
image string
First frame image, URL
lastFrame string
Last frame image, URL
video string
Input video, URL or Base64 encoded
referenceImages array
Reference image list, maximum 3 images
Note:
Veo 3.1 model does not support referenceImages.style. If you want to use style image, please use veo-2.0-generate-exp
Following models support referenceImages: veo-2.0-generate-exp (Preview), veo-3.1-generate-preview (Preview)
image
stringReference image, URL or Base64 encoded
referenceType
stringReference type
Value:
asset
Polling
Since result generation takes time, you need to poll the task status after creating the task.
The initial response only returns information such as the task ID and initial status. The final result must be obtained by polling the task status endpoint using the task ID.
See the examples on the right for polling requests and responses.
Response Format
error object
Error information. Only present when status is failed
code
integerError code
error_message
stringDetailed error message
output array
Generation results. Only present when status is completed
content
arrayList of generated content
type
stringResource type
Value:
videourl
stringContent URL
jobId
stringJob ID
usage object
Usage statistics. Only present when status is completed
cost
stringTotal cost in USD
discount
numberDiscount amount
input_tokens
integerNumber of input tokens
output_tokens
integerNumber of output tokens
total_tokens
integerTotal number of tokens
metadata object
Metadata information
Error Codes
| Error Code | Description |
|---|---|
| 005002095 | Internal generation error |
| 005002096 | Result parsing error |
| 005002097 | HTTP error response |
| 005002098 | Status check error |
| 005002099 | Task creation error/service unavailable |