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: vtrix-veo-3.1-generate-preview
prompt string required
Video generation prompt describing the desired scene
seconds string
Video duration in seconds
Options: 8
size string
Video resolution
Options: 1280x720, 720x1280
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
id string required
Task ID
created_at integer required
Task creation timestamp
status string required
Task status
Options: in_progress, completed, failed
model string required
Model ID
progress number
Progress (0.0-1.0), only present when status is in_progress
error object
Error information, only present when status is failed
code
stringError code
message
stringError message
output array
Generation results, only present when status is completed
content
arrayContent array
type
stringContent type: video
url
stringVideo URL
duration
integerVideo duration in seconds
jobId
stringRemote job ID
usage object
Usage information
metadata object
Metadata including timing information
Error Codes
| Error Code | Description |
|---|---|
| 002014001 | Video generation failed |