API Reference
Render Status API
API reference for the render status endpoint.
The Render Status API allows you to check the status of a video render.
Endpoint
GET /api/render/status/[renderId]
Authorization
All API requests require an API key to be included in the Authorization
header.
Authorization: Bearer YOUR_API_KEY
URL Parameters
Parameter | Type | Description |
---|---|---|
renderId | string | The ID of the render to check. |
Example Request
GET /api/render/status/some-render-id
Example Response
In Progress
{
"status": "rendering"
}
Completed
{
"status": "done",
"outputFile": "https://example.com/video.mp4"
}
Error
{
"status": "error",
"error": "A description of the error."
}