Authorizations
##All APIs require Bearer Token authentication##
Get API Key:
Visit API Key Management Page to get your API Key
Add to request header when using:
Authorization: Bearer YOUR_API_KEYBody
Video generation model name
"sora-2"
Prompt describing what kind of video to generate
1000"A cat playing piano"
Video aspect ratio, 16:9 generates landscape video, 9:16 generates portrait video
16:9, 9:16 "16:9"
Reference image URL list for image-to-video feature
Note:
- Images containing real human figures are not supported
- Single request supports input image quantity:
1image - Image size: no more than
10MB - Supported file formats:
.jpg,.jpeg,.png,.webp - Image URLs must be directly viewable by the server, or the image URL should trigger direct download when accessed (typically these URLs end with image file extensions, such as
.png,.jpg)
1["http://example.com/image1.jpg"]Whether to remove video watermark, by default it will be removed
Note:
true: Remove watermark, higher pricing. This is the default value, please note when sending requestsfalse: Keep watermark, standard pricing
true
Specifies the generated video duration (seconds), default is 10, representing 10 seconds
Note:
- Only supports
10,15values, representing10 seconds,15 seconds - Billing is based on the
durationvalue,15 secondscosts more than10 seconds
10
HTTPS callback address after task completion
Callback Timing:
- Triggered when task is completed, failed, or cancelled
- Sent after billing confirmation is completed
Security Restrictions:
- Only HTTPS protocol is supported
- Callback to internal IP addresses is prohibited (127.0.0.1, 10.x.x.x, 172.16-31.x.x, 192.168.x.x, etc.)
- URL length must not exceed
2048characters
Callback Mechanism:
- Timeout:
10seconds - Maximum
3retries on failure (retries after1second/2seconds/4seconds) - Callback response body format is consistent with the task query API response format
- Callback address returning 2xx status code is considered successful, other status codes will trigger retry
"https://your-domain.com/webhooks/video-task-completed"
Response
Video generation task created successfully
Task creation timestamp
1757169743
Task ID
"task-unified-1757169743-7cvnl5zw"
Actual model name used
"sora-2"
Specific task type
video.generation.task Task progress percentage (0-100)
0 <= x <= 1000
Task status
pending, processing, completed, failed "pending"
Video task detailed information
Task output type
text, image, audio, video "video"
Usage and billing information