Sora-2 Video Generation Lite
- Sora 2 (sora-2) model supports text-to-video, image-to-video and other modes
- Asynchronous processing mode, use the returned task ID to query
- Generated video links are valid for 24 hours, please save them promptly
Note: - Currently Sora2's content moderation mechanism is very strict, tasks may fail due to this - Image input containing real human figures is not currently supported
OpenAPI
````yaml en/api-manual/video-series/sora2/sora2-video-generate.json post /v1/videos/generations openapi: 3.1.0 info: title: sora-2 Interface description: >- Use AI models to create video generation tasks, supporting text-to-video, image-to-video and other generation modes license: name: MIT version: 1.0.0 servers: - url: https://ai.odkkk.com/apiv1 description: Production environment security: - bearerAuth: [] tags: - name: Video Generation description: AI video generation related APIs paths: /v1/videos/generations: post: tags: - Video Generation summary: sora-2 Interface description: >- - Sora 2 (sora-2) model supports text-to-video, image-to-video and other modes
- Asynchronous processing mode, use the returned task ID to
[query](/en/api-manual/task-management/get-task-detail)
- Generated video links are valid for 24 hours, please save them
promptly
**Note:**
- Currently Sora2's content moderation mechanism is very strict, tasks
may fail due to this
- Image input containing real human figures is not currently supported
operationId: createVideoGeneration
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/VideoGenerationRequest'
examples:
text_to_video:
summary: Text to Video
value:
model: sora-2
prompt: A cat playing piano
responses:
'200':
description: Video generation task created successfully
content:
application/json:
schema:
$ref: '#/components/schemas/VideoGenerationResponse'
'400':
description: Invalid request parameters
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error:
code: 400
message: Invalid duration parameter
type: invalid_request_error
param: duration
fallback_suggestion: use duration between 1-12 seconds
'401':
description: Unauthorized, invalid or expired token
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error:
code: 401
message: Invalid or expired token
type: authentication_error
'402':
description: Insufficient quota, recharge required
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error:
code: 402
message: Insufficient quota
type: insufficient_quota_error
fallback_suggestion: https://ai.odkkk.com/apiv1/dashboard/billing
'403':
description: Access denied
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error:
code: 403
message: Access denied for this model
type: permission_error
param: model
'404':
description: Resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error:
code: 404
message: Specified model not found
type: not_found_error
param: model
fallback_suggestion: sora-2
'413':
description: Request entity too large
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error:
code: 413
message: Image file too large
type: request_too_large_error
param: image_urls
fallback_suggestion: compress image to under 4MB
'429':
description: Rate limit exceeded
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error:
code: 429
message: Rate limit exceeded
type: rate_limit_error
fallback_suggestion: retry after 60 seconds
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error:
code: 500
message: Internal server error
type: internal_server_error
fallback_suggestion: try again later
'502':
description: Upstream service error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error:
code: 502
message: Upstream AI service unavailable
type: upstream_error
fallback_suggestion: try different model
'503':
description: Service temporarily unavailable
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error:
code: 503
message: Service temporarily unavailable
type: service_unavailable_error
fallback_suggestion: retry after 30 seconds
components:
schemas:
VideoGenerationRequest:
type: object
required:
- model
- prompt
properties:
model:
type: string
description: Video generation model name
default: sora-2
example: sora-2
prompt:
type: string
description: >-
Prompt describing what kind of video to generate, limited to 5000
tokens
example: A cat playing piano
maxLength: 5000
aspect_ratio:
type: string
description: >-
Video aspect ratio, 16:9 generates landscape video, 9:16
generates portrait video
enum:
- '16:9'
- '9:16'
example: '16:9'
duration:
type: integer
description: >-
Specifies the generated video duration (seconds), default is 10,
representing 10 seconds
**Note:**
- Only supports `10`, `15` values, representing `10 seconds`, `15
seconds`
- Billing is based on the `duration` value, `15 seconds` costs more
than `10 seconds`
example: 10
image_urls:
type: array
description: >-
Reference image URL list for image-to-video feature
**Note:**
- Images containing real human figures are not supported
- Single request supports input image quantity: `1` image
- 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`)
items:
type: string
format: uri
maxItems: 1
example:
- http://example.com/image1.jpg
remove_watermark:
type: boolean
description: >-
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 requests
- `false`: Keep watermark, standard pricing
example: true
callback_url:
type: string
description: >-
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 `2048` characters
**Callback Mechanism:**
- Timeout: `10` seconds
- Maximum `3` retries on failure (retries after `1` second/`2`
seconds/`4` seconds)
- 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
format: uri
example: https://your-domain.com/webhooks/video-task-completed
VideoGenerationResponse:
type: object
properties:
created:
type: integer
description: Task creation timestamp
example: 1757169743
id:
type: string
description: Task ID
example: task-unified-1757169743-7cvnl5zw
model:
type: string
description: Actual model name used
example: sora-2
object:
type: string
enum:
- video.generation.task
description: Specific task type
progress:
type: integer
description: Task progress percentage (0-100)
minimum: 0
maximum: 100
example: 0
status:
type: string
description: Task status
enum:
- pending
- processing
- completed
- failed
example: pending
task_info:
$ref: '#/components/schemas/VideoTaskInfo'
description: Video task detailed information
type:
type: string
enum:
- text
- image
- audio
- video
description: Task output type
example: video
usage:
$ref: '#/components/schemas/VideoUsage'
description: Usage and billing information
ErrorResponse:
type: object
properties:
error:
type: object
properties:
code:
type: integer
description: HTTP status error code
message:
type: string
description: Error description
example: Invalid request parameters
type:
type: string
description: Error type
example: invalid_request_error
param:
type: string
description: Related parameter name
example: model
fallback_suggestion:
type: string
description: Suggestion for error resolution
example: runway-gen3
VideoTaskInfo:
type: object
properties:
can_cancel:
type: boolean
description: Whether the task can be cancelled
example: true
estimated_time:
type: integer
description: Estimated completion time (seconds)
minimum: 0
example: 300
video_duration:
type: integer
description: Video duration (seconds)
example: 9
VideoUsage:
type: object
description: Usage and billing information
properties:
billing_rule:
type: string
description: Billing rule
enum:
- per_call
- per_token
- per_second
example: per_call
credits_reserved:
type: number
description: Estimated credits consumed
minimum: 0
example: 7
user_group:
type: string
description: User group category
example: default
securitySchemes: bearerAuth: type: http scheme: bearer description: >- ##All APIs require Bearer Token authentication##
**Get API Key:**
Visit [API Key Management Page](https://ai.odkkk.com/apiv1/dashboard/keys) to
get your API Key
**Add to request header when using:**
```
Authorization: Bearer YOUR_API_KEY
```
````
To find navigation and other pages in this documentation, fetch the llms.txt file at: https://ai.odkkk.com/apiv1/docs/llms.txt