Documentation Index
Fetch the complete documentation index at: https://docs.prismvideos.com/llms.txt
Use this file to discover all available pages before exploring further.
Returns the current status of a video generation submitted through the API or started from the Prism dashboard. Poll this endpoint to check if your video is ready.
Path parameters
| Parameter | Type | Description |
|---|
id | string | The video generation ID |
Request
curl "https://www.prismvideos.com/api/generations/gen_abc123" \
-H "Authorization: Bearer prism_sk_your_key_here"
Response (generating)
{
"id": "gen_abc123",
"status": "generating",
"template_id": "abc123",
"video_url": null,
"share_url": null,
"created_at": "2026-02-26T12:00:00.000Z",
"completed_at": null,
"error": null
}
Response (completed)
{
"id": "gen_abc123",
"status": "completed",
"template_id": "abc123",
"video_url": "https://presigned-s3-url...",
"share_url": "https://www.prismvideos.com/workspace/s/share_abc123",
"created_at": "2026-02-26T12:00:00.000Z",
"completed_at": "2026-02-26T12:02:30.000Z",
"error": null
}
Response (failed)
{
"id": "gen_abc123",
"status": "failed",
"template_id": "abc123",
"video_url": null,
"share_url": null,
"created_at": "2026-02-26T12:00:00.000Z",
"completed_at": null,
"error": "Generation timed out"
}
Response fields
| Field | Type | Description |
|---|
id | string | The generation ID |
status | string | "generating", "completed", or "failed" |
template_id | string or null | The template ID (if generated from a template) |
video_url | string or null | Presigned URL to download the video (1 hour expiry). Only present when status is "completed". |
share_url | string or null | Public Prism share page URL, matching the in-app Share button. Only present when status is "completed". |
created_at | string or null | ISO 8601 timestamp when generation was submitted |
completed_at | string or null | ISO 8601 timestamp when generation finished. Only present when status is "completed". |
error | string or null | Error message. Only present when status is "failed". |
Polling strategy
Video generation typically takes 30 seconds to 3 minutes depending on the model and duration. A recommended polling approach:
- Wait 5 seconds after submitting.
- Poll every 5 seconds.
- Stop after
status is "completed" or "failed".
Errors
| Status | Error | When |
|---|
| 401 | unauthorized | Missing or invalid API key |
| 403 | forbidden | API key lacks templates:read scope |
| 404 | not_found | Generation not found or not owned by this API key’s user |
See Errors for the full error reference.