Skip to content

Get Video Generation Task Status ​

Query the status and results of a video generation task.

Task statuses:

  • queued: Queued
  • in_progress: In Progress
  • completed: Completed
  • failed: Failed

Query Task ​

http
GET /v1/video/generations/{task_id}

Authentication: Bearer Token, format Authorization: Bearer <API Key>.

Path Parameters:

ParameterTypeRequiredDescription
task_idstringYesTask ID
bash
curl -X GET 'https://neolink.com/api/v1/video/generations/<task_id>' \
--header 'Authorization: Bearer <API Key>'
python
import requests

API_KEY = "<API Key>"
TASK_ID = "<task Id>"

url = f"https://neolink.com/api/v1/video/generations/{TASK_ID}"

headers = {
    "Authorization": f"Bearer {API_KEY}"
}

response = requests.get(url, headers=headers)
response.raise_for_status()

print(response.json())

Response Format ​

Success Response (HTTP 200) ​

FieldTypeDescription
task_idstringTask ID
statusstringTask status (queued / in_progress / completed / failed)
urlstringVideo URL (returned on success)
formatstringVideo format (e.g. mp4)
metadataobjectVideo task metadata
metadata.durationintegerVideo duration (seconds)
metadata.fpsintegerFrame rate
metadata.widthintegerVideo width
metadata.heightintegerVideo height
metadata.seedintegerRandom seed
errorobjectError info object
error.codeintegerError code
error.messagestringError description
json
{
  "task_id": "abcd1234efgh",
  "status": "completed",
  "url": "https://example.com/video.mp4",
  "format": "mp4",
  "metadata": {
    "duration": 5,
    "fps": 30,
    "width": 1280,
    "height": 720,
    "seed": 20231234
  },
  "error": {
    "code": 0,
    "message": "string"
  }
}

Error Response (HTTP 404) ​

FieldTypeDescription
errorobjectError object
error.messagestringError message
error.typestringError type
error.paramstringRelated parameter
error.codestringError code
json
{
  "error": {
    "message": "string",
    "type": "string",
    "param": "string",
    "code": "string"
  }
}

Tip: This API queries the status of asynchronous video generation tasks. It is recommended to use a polling mechanism. When the status changes to completed, the generated video file can be accessed via the url field.