renders

List renders

Returns a cursor-paginated list of render jobs for the authenticated workspace.

get/v1/renders

Request

  • Base URL: https://api.framelane.io
  • URL: https://api.framelane.io/v1/renders
  • Auth: HTTP bearer

Query parameters

status'ingesting' | 'queued' | 'processing' | 'completed' | 'failed' | 'cancelled'

Values:

  • ingesting — External source files are being probed for duration before the render is queued.
  • queued — Accepted and waiting for a worker to pick it up.
  • processing — Actively rendering or processing.
  • completed — Finished successfully; the output artifact is available.
  • failed — Terminated with an error (see error).
  • cancelled — Cancelled by the caller before completion.
project_idstring nullable

Only return renders submitted for this project (POST /v1/projects/{id}/renders).

limitinteger
cursorstring nullable

Response

Successful Response

next_cursorstring nullable
has_moreboolean

Example response

{
  "data": [
    {
      "id": "render_01J8QR2K5VKDGN2T4FBM3CZYX7",
      "workspace_id": "ws_01J8QR2K5VKDGN2T4FBM3CZYX8",
      "output": {
        "url": "https://cdn-user.framelane.io/render_01J.../output.mp4",
        "width": 1920,
        "height": 1080,
        "duration": 15.3,
        "size_bytes": 12582912
      },
      "result": {
        "language_code": "en",
        "text": "Welcome back to the show."
      },
      "error": {
        "message": "Source URL returned 404."
      },
      "metadata": {
        "project_id": "proj_123",
        "user_ref": "usr_abc"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.