API Reference
Retrieve a unified video or image task
Retrieve a unified video or image task. The following is this gateway’s public contract.
Preview guide
Paste into an AI assistant to help with integration. Documentation and examples only; no real credentials.
Updated · Reviewed
Endpoint and authentication
GET https://api.tu-zi.com/v1/videos/{task_id}
Transport: json
Use an inference API key. Examples contain placeholders; read credentials from environment variables.
Authorization: Bearer YOUR_API_KEY
Before running
Replace https://api.tu-zi.com with this site origin (do not append /v1 twice), and YOUR_MODEL with the exact marketplace model ID. Install requests for Python; use Node.js 20+ and save JavaScript as .mjs. WebSocket samples list their own dependencies.
Create an inference key on the site and set API_KEY in the environment; replace YOUR_API_KEY in cURL. Prepare local input.png/input.wav files for upload examples.
Start with a minimal request, then read the result using the response fields below. For async APIs, a returned task ID requires polling; acceptance does not mean generation has finished.
Constraints
This route can represent asynchronous image or video tasks. Do not assume every task is a video. The model adapter converts the result and may return 501 when it does not implement the unified format. Missing or unauthorized tasks return errors.
Path parameters
| Field | Type | Required | Description / constraints |
|---|---|---|---|
| task_id | string | Yes | Public task ID returned by this gateway. Example: YOUR_TASK_ID |
Response fields
| Field | Type | Description / constraints |
|---|---|---|
| id | string | Gateway task ID. |
| status | string | Common values are queued, in_progress, completed and failed; follow the selected model adapter. |
| error | object | null | Failure information. |
| video_url | string | Save id and GET /v1/videos/{task_id} with the same inference API key. queued and in_progress are pending; completed is terminal success: read video_url and download the image. failed is terminal failure: read error.message and stop. video_url is a compatibility field containing an image URL, not a video; do not parse synchronous data[].url. Bound polling by attempt count and deadline with exponential backoff. Missing result URLs or unknown states require an error/check, not success or endless polling. |
Illustrative response; some endpoints show essential fields only. Optional fields may be absent.
{
"id": "task_example",
"status": "queued"
}
Errors and retries
Check HTTP status and protocol-specific errors; do not mix error formats across protocols. For 401/403 check credentials and permissions, for 429 back off, and for 5xx check gateway/upstream status. Error bodies may contain error/message/code depending on the protocol.
Use bounded exponential backoff for reads. Do not blindly retry task creation, generation, or key mutations, to avoid duplicate billing or execution.
兔子API