---
title: "Get render state"
method: GET
path: "/api/v1/projects/{projectId}/renders/{renderId}"
tags: ["Rendering"]
---

# Get render state

`GET /api/v1/projects/{projectId}/renders/{renderId}`

## Request

- Base URL: `https://prismclip.com`
- URL: `https://prismclip.com/api/v1/projects/{projectId}/renders/{renderId}`
- Auth: HTTP bearer

Retrieve durable render status, progress, settings, preview and download URLs, and source provenance identifiers for an owned render.

## Path parameters

- `projectId` string, uuid, required
- `renderId` string, uuid, required

## Response `200`

Durable render state with media URLs when complete.

- object
  - `render` object, required
    - `id` string, uuid, required
    - `projectId` string, uuid, required
    - `momentSetId` string, uuid, required
    - `aspectRatio` string, required
    - `framing` string, required
    - `cropAnalysisId` string, uuid, nullable, required
    - `captions` boolean, required
    - `captionStyle` string, required
    - `transition` string, required
    - `renderTarget` 'cloud', required
    - `segmentIds` string[], required
    - `status` string, required
    - `progressPercent` integer, required
    - `error` string, nullable, required
    - `createdAt` string, required: ISO 8601 timestamp
    - `updatedAt` string, required: ISO 8601 timestamp
    - `rendererVersion` string, nullable, required
    - `downloadUrl` string, nullable, required
    - `previewUrl` string, nullable, required
    - `provenance` object, required
      - `projectId` string, uuid, required
      - `momentSetId` string, uuid, required
      - `segmentIds` string[], required
      - `rendererVersion` string, nullable, required

## Other responses

- `401`: The API key is missing or invalid.
- `403`: The API key lacks projects:read.
- `404`: The owned render was not found.
- `429`: The API-key rate limit was exceeded.
- `503`: Render state is unavailable.

---

[API](https://skmtc.dev/prismclip/apis/prismclip-api.md) · [All operations](https://skmtc.dev/prismclip/apis/prismclip-api/llms.txt) · [OpenAPI document](https://skmtc.dev/prismclip/apis/prismclip-api/revisions/05eda9436f1d?raw)
