Retrieve a video task

OpenAI-compatible endpoint for retrieving video task status. Returns detailed status information for the video task.

GET /v1/videos/{task_id}

Service root: https://getrouter.ai

Protocol: Video task API

Authentication: Authorization: Bearer YOUR_API_KEY

Parameters

ParameterLocationTypeRequiredDescription
task_idpathstringYesVideo task ID

Example request

curl --request GET \
  --url https://getrouter.ai/v1/videos/TASK_ID \
  --header "Authorization: Bearer YOUR_API_KEY"

Responses

StatusDescription
200Video task status retrieved successfully
404Task not found

Success response fields

FieldTypeRequiredDescription
idstringYes
objectstringYes
modelstringYes
statusstringYes
progressintegerYes
created_atintegerYes
secondsstringYes

Example response

{
  "id": "string",
  "object": "object",
  "model": "MODEL_ID",
  "status": "completed",
  "progress": 1,
  "created_at": 1,
  "seconds": "string"
}

For complete workflows and examples, read the Video Generation API Guide.


This page is generated from the public Relay OpenAPI specification. Browse the complete specification in the API Explorer.