Skip to main content
POST
/
api
/
v1
/
jobs
/
createTask
Generate character animations using sora-2-characters-pro
curl --request POST \
  --url https://api.kie.ai/api/v1/jobs/createTask \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "model": "sora-2-characters-pro",
  "callBackUrl": "https://your-domain.com/api/callback",
  "input": {
    "origin_task_id": "7118f712c1f35c9b8bf2ad1af68ad482",
    "timestamps": "3.55,5.55",
    "character_user_name": "my_character_01",
    "character_prompt": "A friendly cartoon character with expressive eyes and fluid movements",
    "safety_instruction": "Ensure the animation is family-friendly and contains no violent or inappropriate content"
  }
}
'
{
  "code": 200,
  "msg": "success",
  "data": {
    "taskId": "task_sora-2-characters-pro_1765174270120"
  }
}

ā€‹
Prerequisites

The Sora-2-characters-pro API generates character animations from an existing video generation task. You must have a completed task before using this API:
1

Complete a Video Generation Task

First, use one of the Sora video generation APIs (e.g., Text to Video or Image to Video) to create a video.
2

Obtain Task ID

After the video generation completes successfully, note the taskId from the response. This becomes your origin_task_id.
3

Specify Video Segment

Use the timestamps parameter to define which segment of the video to use. Format: "x,y" (e.g., "3.55,5.55"). The segment duration (y - x) must be between 1-4 seconds.
4

Submit Character Animation Task

Provide origin_task_id, timestamps, and character_prompt to generate character animations. Optionally include character_user_name to identify the character for reference.

ā€‹
Parameter Reference

ParameterTypeRequiredDescription
origin_task_idstringYesTask ID of the original video generation task
timestampsstringYesVideo segment time range. Format: "x,y" (e.g., "3.55,5.55"). Extracts segment from x to y seconds. Duration (y - x) must be 1-4 seconds
character_user_namestringNoOptional. Custom name for the character, used to identify and reference in subsequent operations. Max 40 characters when provided
character_promptstringYesCharacter persona prompt describing personality and appearance
safety_instructionstringNoSafety guidelines and content restrictions for the animation
Timestamp Constraints: The timestamps parameter must define a segment between 1-4 seconds. For example, "3.55,5.55" extracts a 2-second segment. Invalid durations will cause processing errors.
Use the Get Task Details endpoint to verify your original video task has completed successfully before submitting a character animation request.

ā€‹
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": "example_123456789"
}
The character_id can be used to reference the generated character animation in subsequent operations.
For production use, we recommend using the callBackUrl parameter to receive automatic notifications when generation completes, rather than polling the status endpoint.

Market Overview

Explore all available models

Common API

Check credits and account usage

Authorizations

ā€‹
Authorization
string
header
required

All APIs require authentication via Bearer Token.

Get API Key:

  1. 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
ā€‹
model
enum<string>
default:sora-2-characters-pro
required

The model name to use for generation. Required field.

  • Must be sora-2-characters-pro for this endpoint
Available options:
sora-2-characters-pro
Example:

"sora-2-characters-pro"

ā€‹
callBackUrl
string<uri>

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
object

Input parameters for the generation task

Response

Request successful

ā€‹
code
enum<integer>

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
ā€‹
msg
string

Response message, error description when failed

Example:

"success"

ā€‹
data
object