Sora 2 AI Video Generator API documentation
Generate videos with Sora 2 AI Video Generator (OpenAI). Supports both text and image input modes.
Endpoints
| Contract item | Value |
|---|---|
| Capability | sora-2-ai-video-generator |
| Submit | POST https://vidmage.ai/api/v1/sora-2-ai-video-generator/submit |
| Query | POST https://vidmage.ai/api/v1/sora-2-ai-video-generator/query |
| Task identifier | taskId |
| Result field | videoUrl |
Authenticate with Authorization: Bearer YOUR_API_KEY. Save the task identifier and query the same capability. Use a stable Idempotency-Key for submission retries.
Product guide: Sora 2 API
Parameters and input rules
| Field | Type | Required | Default | Meaning and limits |
|---|---|---|---|---|
prompt | string | Yes | Not specified | Text prompt describing the video to generate (max 4000 chars). Minimum characters: 5Maximum characters: 4000 |
imageUrl | string | No | Not specified | Optional input image URL. When provided, the task runs in image-to-video mode. |
duration | string | No | "10" | Video duration in seconds. Values: "10", "15" |
aspectRatio | string | No | "9:16" | Output aspect ratio. Values: "16:9", "9:16" |
storyboard | boolean | No | false | Enable storyboard-based planning for the generated video. |
text to video
These are public VidMage field names. The server maps them to provider fields. Input media selects the mode; use its limits together with the parameter table.
| Control | Mode-specific rule |
|---|---|
prompt | Required; 5–4000 characters. |
duration | JSON string. Values: "10", "15". Default: 10. |
aspectRatio | Values: "16:9", "9:16". Default: 9:16. |
resolution | Not used in this mode. |
storyboard | Enable storyboard-based planning for the generated video. Default: false |
image to video
These are public VidMage field names. The server maps them to provider fields. Input media selects the mode; use its limits together with the parameter table.
| Control | Mode-specific rule |
|---|---|
prompt | Required; 5–4000 characters. |
duration | JSON string. Values: "10", "15". Default: 10. |
aspectRatio | Values: "16:9", "9:16". Default: 9:16. |
resolution | Not used in this mode. |
imageUrl | Formats: jpg, png. |
storyboard | Enable storyboard-based planning for the generated video. Default: false |
Example request
{
"prompt": "An astronaut explores a greenhouse on Mars while dust moves softly outside the glass walls",
"duration": "10",
"aspectRatio": "9:16",
"storyboard": false
}# Set VIDMAGE_IDEMPOTENCY_KEY to a unique value for this task; preserve it for transport retries.
curl -X POST "https://vidmage.ai/api/v1/sora-2-ai-video-generator/submit" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Idempotency-Key: ${VIDMAGE_IDEMPOTENCY_KEY}" \
-H "Content-Type: application/json" \
-d '{"prompt":"An astronaut explores a greenhouse on Mars while dust moves softly outside the glass walls","duration":"10","aspectRatio":"9:16","storyboard":false}'
# -> { "success": true, "taskId": "...", "creditsConsumed": ... }Task results and recovery
URL of the generated video. Read videoUrl from the completed query response. Preserve taskId while the task is running.
curl -X POST "https://vidmage.ai/api/v1/sora-2-ai-video-generator/query" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "taskId": "TASK_ID_FROM_SUBMIT" }'
# -> { "success": true, "data": { "status": "...", "videoUrl": "https://..." } }Submission and task queries report the available task and usage information. A timeout is not a confirmed failure. Recover the existing task instead of resubmitting.
For face selection and error recovery, follow Task lifecycle. MCP uses the normalized taskId argument in get_task_result, including capabilities whose REST identifier is requestId.
Credits
| Component / option | Rate | Minimum |
|---|---|---|
| Base rate | 5 credits / second | — |
Base charge = duration × the selected resolution rate.
Use the Playground or the MCP credit estimator for your exact inputs. Credits and billing.