Build on top of the AI Video API

Payload parameters

• model: Required. Use "sora-2", "sora-2-pro", or "sora-2-stable" to target the model variant you need.
• prompt: Required. Natural language description of the scene you want Sora to create.
• imageData: Optional (recommended). Base64 data URL with prefix "data:image/*;base64," for image-to-video mode.
• url: Optional. Legacy reference image URL; still supported but lower priority than imageData.
• aspectRatio: Optional. Supported values: "9:16" (default) or "16:9".
• duration: Optional. Only for "sora-2-stable"; choose 10 or 15 seconds (default 10).
• isPublic: Optional. Whether to display the video publicly; default is true.
• remixTargetId: Optional (VIP only). Target video pid for continuation/remix features.
• characters: Optional (VIP only). Character control array; each item includes url and timestamps.

Sample request

curl -X POST https://freesoragenerator.com/api/v1/video/sora-video \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "sora-2-stable",
    "prompt": "A cinematic shot of a futuristic city at sunset, captured in 4K.",
    "imageData": "data:image/png;base64,iVBORw0KGgoAAA...",
    "aspectRatio": "9:16",
    "duration": 15,
    "isPublic": true
  }'

Sample response

{
  "code": 0,
  "message": "ok",
  "data": {
    "id": "task_1234567890"
  }
}

Payload parameters

• taskId: Required. The identifier returned when you created the generation task.

Sample request

curl -X POST https://freesoragenerator.com/api/video-generations/check-result \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "taskId": "task_1234567890"
  }'

Sample response

{
  "code": 0,
  "message": "Success",
  "data": {
    "status": "running",
    "progress": 35,
    "result_url": "https://your-domain.com/storage/videos/xxx.mp4",
    "result_urls": [
      "https://your-domain.com/storage/videos/xxx.mp4"
    ],
    "failure_reason": "",
    "error_message": null,
    "credits_refunded": false,
    "refund_trans_no": null,
    "result_pid": "s_xxx",
    "result_pids": [
      "s_xxx"
    ],
    "metadata": {
      "remixTargetId": "s_prev",
      "characters": [
        {
          "url": "https://.../hero.mp4",
          "timestamps": "0,3"
        }
      ]
    }
  }
}

Sample request

curl -X POST https://freesoragenerator.com/api/get-user-credits \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Sample response

{
  "code": 0,
  "message": "ok",
  "data": {
    "left_credits": 120,
    "is_recharged": true,
    "is_pro": true,
    "is_vip": false
  }
}