Skip to main content
GET
https://octopusx.ai
/
v1
/
video
/
generations
/
{task_id}
Get Task Status
curl --request GET \
  --url https://octopusx.ai/v1/video/generations/{task_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "task_id": "<string>"
}
'
{
  "code": "success",
  "message": "",
  "data": {
    "task_id": "task-video-abc123",
    "status": "queued",
    "url": "",
    "format": "mp4",
    "metadata": null,
    "error": null
  }
}

Get Task Status

This endpoint is used to query the status of asynchronous tasks submitted through the unified video task entry point. The returned structure is wrapped with code, message, and data.
  • The query targets the platform-exposed task_id, not the upstream real task ID.
  • A successful response always returns code = success.
  • Suitable for use together with /v1/video/generations.
  • The same task can also be queried via /v1/videos/{task_id} in the OpenAI video object format.

Method and Path

GET /v1/video/generations/{task_id}

Request Example

curl https://octopusx.ai/v1/video/generations/task-video-abc123 \
  -H "Authorization: Bearer YOUR_API_KEY"

Response Example

{
  "code": "success",
  "message": "",
  "data": {
    "task_id": "task-video-abc123",
    "status": "queued",
    "url": "",
    "format": "mp4",
    "metadata": null,
    "error": null
  }
}

Authentication

Authorization: Bearer YOUR_API_KEY

Path Parameters

task_id
string
required
The public task ID returned by the unified video task entry point.

Response

code
string
Business status code. Fixed as success on success.
message
string
Error or supplementary information. Usually an empty string on success.
data.task_id
string
Task ID.
data.status
string
Task status. Common values are queued, processing, succeeded, and failed.
data.url
string
Final video result URL. Some channels may return a platform proxy URL.
data.error
object
Error details for failed tasks.

Use Cases

Poll Until Completion

It is recommended to poll every 5 to 10 seconds until status becomes succeeded or failed.

Switch to the OpenAI Query Structure

If the client is already parsing results according to the OpenAI video object, you can directly query:
curl https://octopusx.ai/v1/videos/task-video-abc123 \
  -H "Authorization: Bearer YOUR_API_KEY"

Notes

/v1/video/generations/{task_id} and /v1/videos/{task_id} query the same type of video task, but return different structures. The former is a unified task wrapper, while the latter is an OpenAI video object.