Sora-2 API Reference

Overview

Property	Value
Model ID	`sora-2`
Type	Text-to-Video, Image-to-Video
Pricing	10s video: $0.5 · 15s video: $0.75
Average Time	3-5 minutes

Authentication

All API requests require authentication using a Bearer token in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Endpoints

1. Submit Generation Task

POST https://api.apixo.ai/api/v1/generateTask/sora-2

2. Query Task Status

GET https://api.apixo.ai/api/v1/statusTask/sora-2?taskId={taskId}

Request Parameters

Request Body Structure

{
  "request_type": "async",
  "callback_url": "https://your-server.com/callback",
  "input": {
    "mode": "text-to-video",
    "prompt": "Your video description",
    "n_frames": "10",
    ...
  }
}

Top-Level Parameters

Parameter	Type	Required	Description
`request_type`	string	Yes	Request mode: `async` (poll results) or `callback` (webhook notification)
`callback_url`	string	No	Webhook URL for callback mode. Must be publicly accessible
`input`	object	Yes	Generation parameters (see below)

Input Parameters

Parameter	Type	Required	Default	Description
`mode`	string	Yes	`text-to-video`	Generation mode: `text-to-video` or `image-to-video`
`prompt`	string	Yes	-	Video description (max 10,000 characters)
`image_urls`	string[]	No	-	Single image URL for image-to-video (max 10MB, jpeg/png/webp)
`n_frames`	string	Yes	`10`	Video duration: `10` (10s, $0.5) or `15` (15s, $0.75)
`aspect_ratio`	string	No	`landscape`	Aspect ratio: `portrait` or `landscape`
`remove_watermark`	boolean	No	`true`	Remove watermark from generated video

Response Format

Task Submission Response

{
  "code": 200,
  "message": "success",
  "data": {
    "taskId": "task_12345678"
  }
}

Status Query Response

Processing:

{
  "code": 200,
  "message": "success",
  "data": {
    "taskId": "task_12345678",
    "state": "processing",
    "createTime": 1698765400000
  }
}

Success:

{
  "code": 200,
  "message": "success",
  "data": {
    "taskId": "task_12345678",
    "state": "success",
    "resultJson": "{\"resultUrls\":[\"https://example.com/video.mp4\"]}",
    "costTime": 240000,
    "createTime": 1698765400000,
    "completeTime": 1698765640000
  }
}

Failed:

{
  "code": 200,
  "message": "success",
  "data": {
    "taskId": "task_12345678",
    "state": "failed",
    "failCode": "CONTENT_VIOLATION",
    "failMsg": "Content does not meet safety guidelines",
    "createTime": 1698765400000,
    "completeTime": 1698765640000
  }
}

Response Fields:

Field	Type	Description
`code`	integer	HTTP status code (200 = success)
`data.taskId`	string	Unique task identifier
`data.state`	string	Task state: `pending`, `processing`, `success`, `failed`
`data.resultJson`	string	JSON string with `resultUrls` array (on success)
`data.costTime`	integer	Generation time in milliseconds
`data.failCode`	string	Error code (on failure)
`data.failMsg`	string	Error message (on failure)

Callback Response

When the task is completed, the system will send a POST request to your callBackUrl in the following format:

Success Callback

{
  "code": 200,
  "message": "success",
  "data": {
    "taskId": "task_12345678",
    "state": "success",
    "resultJson": "{\"resultUrls\":[\"https://example.com/result.mp4\"]}",
    "completeTime": 1698765640000,
    "createTime": 1698765400000,
    "costTime": 240000
  }
}

Failure Callback

{
  "code": 400,
  "message": "failed",
  "data": {
    "taskId": "task_12345678",
    "state": "failed",
    "failCode": "CONTENT_VIOLATION",
    "failMsg": "Content does not meet safety guidelines",
    "completeTime": 1698765640000,
    "createTime": 1698765400000,
    "costTime": 240000
  }
}

Quick Start

1. Text-to-Video Generation

curl -X POST https://api.apixo.ai/api/v1/generateTask/sora-2 \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "request_type": "async",
    "input": {
      "mode": "text-to-video",
      "prompt": "A beautiful sunset over the mountains",
      "n_frames": "10",
      "aspect_ratio": "landscape"
    }
  }'

Response:

{
  "code": 200,
  "message": "success",
  "data": {
    "taskId": "task_12345678"
  }
}

2. Check Task Status

curl -X GET "https://api.apixo.ai/api/v1/statusTask/sora-2?taskId=task_12345678" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response (Success):

{
  "code": 200,
  "message": "success",
  "data": {
    "taskId": "task_12345678",
    "state": "success",
    "resultJson": "{\"resultUrls\":[\"https://example.com/video.mp4\"]}"
  }
}

3. Image-to-Video Generation

curl -X POST https://api.apixo.ai/api/v1/generateTask/sora-2 \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "request_type": "async",
    "input": {
      "mode": "image-to-video",
      "prompt": "Animate this landscape with flowing water and moving clouds",
      "image_urls": ["https://example.com/input.jpg"],
      "n_frames": "15",
      "aspect_ratio": "landscape"
    }
  }'

Best Practices

Request Mode Selection

Mode	Use When
Callback	Production environments with public server endpoints
Async	Client-side apps or when webhook setup is not feasible

Performance Tips

Async Mode: Wait 120 seconds before first poll, then poll every 20 seconds
Timeout: Set maximum wait time to 10 minutes
Rate Limiting: Avoid excessive concurrent requests
Error Handling: Always check state field and handle failures gracefully

Resource Management

Video URLs may be temporary - download and store important results
Clean up failed tasks appropriately
Log taskId for debugging and support
Video files are larger than images - ensure adequate storage and bandwidth