Skip to main content
GET
Query video generation task

Overview

All text-to-video or image-to-video submissions return a task_id. Use the video task status endpoint to poll the job until it finishes. The payload mirrors the async submission response and includes downloadable asset URLs when the task succeeds.
Poll every 3–5 seconds to balance freshness with API usage efficiency.

Endpoint

  • GET https://api.siray.ai/v1/video/generations/{task_id}
Headers
  • Authorization: Bearer <SIRAY_API_TOKEN>
Path parameters

Response structure

Fields

  • code / message: Service-level indicators for the polling request.
  • data.task_id: Echo of the video task identifier.
  • data.status: Lifecycle state — values listed below.
  • data.progress: Human-readable progress string.
  • data.outputs: URLs pointing to the generated video assets (present when status is SUCCESS).
  • data.fail_reason: Explains why processing stopped when status is FAILURE.
  • data.submit_time, data.start_time, data.finish_time: Unix timestamps that help track total latency.

Status values

Usage example

When status reaches SUCCESS, stream or download the video from the URLs in outputs. If the task fails, retry after resolving the underlying issue noted in fail_reason.

Authorizations

Authorization
string
header
required

Bearer authentication using API key

Path Parameters

task_id
string
required

Identifier returned from the video generation task submission

Response

200 - application/json

Task status and (if available) generated outputs

Async task status query response

code
string
required

Status code returned by the service

Example:

"success"

message
string
required

Additional information about the request result

Example:

""

data
object
required

Task execution details