Generate character animations using sora-2-characters
Sora2
Sora2 - Characters
Create dynamic character animations powered by Sora-2-characters’ advanced AI model
POST
Generate character animations using sora-2-characters
File Upload Requirements
Before using the Character Animation API, you need to upload your character videos:Upload Character Videos
Visit our File Upload API to upload your character videos.Requirements:
- File Type: MP4, WebM, or AVI format
- Duration: Between 1-4 seconds per video
- Max File Size: 10MB per file
- Content: Character movements or actions you want to animate
Get Upload URLs
After successful upload, you’ll receive file URLs that can be used in the
character_file_url parameter.Additional Parameters
Besides the character video URL, you can provide additional parameters to enhance your character animation:character_prompt: Description of the character and desired animation style (Max 5000 characters)safety_instruction: Safety guidelines and content restrictions for the animation (Max 5000 characters)
Query Task Status
After submitting a task, use the unified query endpoint to check progress and retrieve results:Get Task Details
Learn how to query task status and retrieve generation results
Task Query Response Format
When the task is completed successfully (state: "success"), the resultJson field contains:
character_id can be used to reference the generated character animation in subsequent operations.
Related Resources
Market Overview
Explore all available models
File Upload API
Learn how to upload your character videos
Common API
Check credits and account usage
Authorizations
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
Note:
- Keep your API Key secure and do not share it with others
- If you suspect your API Key has been compromised, reset it immediately in the management page
Body
application/json
The model name to use for generation. Required field.
- Must be
sora-2-charactersfor this endpoint
Available options:
sora-2-characters Example:
"sora-2-characters"
The URL to receive generation task completion updates. Optional but recommended for production use.
- System will POST task status and results to this URL when generation completes
- Callback includes generated content URLs and task information
- Your callback endpoint should accept POST requests with JSON payload containing results
- Alternatively, use the Get Task Details endpoint to poll task status
- To ensure callback security, see Webhook Verification Guide for signature verification implementation
Example:
"https://your-domain.com/api/callback"
Input parameters for the generation task
Response
Request successful
Response status code
- 200: Success - Request has been processed successfully
- 401: Unauthorized - Authentication credentials are missing or invalid
- 402: Insufficient Credits - Account does not have enough credits to perform the operation
- 404: Not Found - The requested resource or endpoint does not exist
- 422: Validation Error - The request parameters failed validation checks
- 429: Rate Limited - Request limit has been exceeded for this resource
- 455: Service Unavailable - System is currently undergoing maintenance
- 500: Server Error - An unexpected error occurred while processing the request
- 501: Generation Failed - Content generation task failed
- 505: Feature Disabled - The requested feature is currently disabled
Available options:
200, 401, 402, 404, 422, 429, 455, 500, 501, 505 Response message, error description when failed
Example:
"success"
