RelayDanceDocs / API Reference / Get Video Task
GET
/v1/video/generations/{task_id}Get Video Task
Retrieve the status and result of a video generation task submitted via Generate Video.
#Path parameters
| Parameter | Type | Description |
|---|---|---|
task_id | string | The task_id returned by POST /v1/video/generations |
#Example request
terminalbash
curl https://relaydance.com/v1/video/generations/task_abc123 \
-H "Authorization: Bearer $RELAYDANCE_API_KEY"#Response
response.jsonjson
{
"task_id": "task_abc123",
"status": "succeeded",
"url": "https://...mp4",
"format": "mp4",
"metadata": { "ratio": "16:9", "resolution": "1080p" }
}#Response fields
| Field | Type | Description |
|---|---|---|
task_id | string | Task identifier |
status | string | submitted | running | succeeded | failed |
url | string | Download URL for the clip (present when status is succeeded) |
format | string | Output container, mp4 |
metadata | object | Echo of the task's vendor parameters |
#Status values
| Status | Meaning |
|---|---|
submitted | Task accepted and queued |
running | Generation in progress |
succeeded | Done: download the clip from url |
failed | Generation failed; failed tasks are not billed |
Poll every few seconds until the status is succeeded or failed.
#Webhook alternative
If the task was submitted with metadata.callback_url, this same task JSON is POSTed to that URL when the task reaches a final state, with retries on delivery failure. In that case polling is unnecessary. See Video Generation.