---
title: "Get live render schema"
canonical_url: https://docs.zvid.io/docs/endpoints/get-render-schema/
source: docs/endpoints/get-render-schema.api.mdx
content_revision: 6338386a1dd87e4a
---

# Get live render schema

`GET /api/render/schema/api-key`

Free, account-aware resolved-project or render-request schema with validation notes and authoring guidance. Template input additionally supports variables, iterate and condition; use the authoring schema and validation endpoint for those fields.

## Authentication

`x-api-key: YOUR_API_KEY` (header). API key for authentication. Create one in your dashboard.

Create API keys at [app.zvid.io/api-keys](https://app.zvid.io/api-keys). Keep credentials on your server.

## Parameters

| Parameter | Location | Type | Required | Description and constraints |
| --- | --- | --- | --- | --- |
| `target` | query | `"project"` / `"render-request"` | No | Default: `"project"`. |

## Request

The shell examples read credentials from `ZVID_API_KEY` (or `ZVID_ACCESS_TOKEN` for Bearer authentication). Set that variable in your environment. Replace sample project, template, job, and asset identifiers with values from your own account.

This operation does not take a request body.

### Request example

```bash
curl --request GET 'https://api.zvid.io/api/render/schema/api-key' \
  --header "x-api-key: $ZVID_API_KEY"
```

## Responses


### HTTP 200

Successful response

Content type: `application/json`.

Required properties: `schemaVersion`, `planLimits`, `target`, `jsonSchema`.

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| `response.schemaVersion` | string | Yes |  |
| `response.sourceOfTruth` | string | No |  |
| `response.planLimits` | object | Yes |  |
| `response.target` | `"project"` / `"render-request"` | Yes |  |
| `response.jsonSchema` | object | Yes |  |
| `response.validationNotes` | array of string | No |  |
| `response.authoringGuidelines` | array of string | No |  |
| `response.authoringWorkflow` | array of string | No |  |

**Nested field: `response.validationNotes`**

**Array item: `response.validationNotes[]`**

Type: string.

**Nested field: `response.authoringGuidelines`**

**Array item: `response.authoringGuidelines[]`**

Type: string.

**Nested field: `response.authoringWorkflow`**

**Array item: `response.authoringWorkflow[]`**

Type: string.


### HTTP 400

Invalid input or semantic validation error

Content type: `application/json`.

Required properties: `error`.

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| `response.error` | string | Yes |  |
| `response.message` | string | No |  |
| `response.details` | array of object | No |  |
| `response.planLimits` | object | No | Present on render validation errors; contains the authenticated user's current render limits. |

**Nested field: `response.details`**

**Array item: `response.details[]`**

Unknown properties are rejected. Required properties: `field`, `message`.

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| `response.details[].field` | string | Yes |  |
| `response.details[].message` | string | Yes |  |


### HTTP 401

Missing or invalid credentials

Content type: `application/json`.

Unknown properties are rejected. Required properties: `error`.

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| `response.error` | string | Yes | Error type |
| `response.message` | string | No | Human-readable error message |


### HTTP 404

Not found for this account

Content type: `application/json`.

Required properties: `error`.

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| `response.error` | string | Yes | Error type |
| `response.message` | string | No | Human-readable error message |


### HTTP 500

Server error

Content type: `application/json`.

Required properties: `error`.

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| `response.error` | string | Yes | Error type |
| `response.message` | string | No | Human-readable error message |


## Schema definitions

The following definitions describe the fields referenced above. Expand a definition to inspect its complete contract.


### schema authoring schema response

**AuthoringSchemaResponse**


Required properties: `schemaVersion`, `planLimits`, `target`, `jsonSchema`.

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| `AuthoringSchemaResponse.schemaVersion` | string | Yes |  |
| `AuthoringSchemaResponse.sourceOfTruth` | string | No |  |
| `AuthoringSchemaResponse.planLimits` | object | Yes |  |
| `AuthoringSchemaResponse.target` | `"project"` / `"render-request"` | Yes |  |
| `AuthoringSchemaResponse.jsonSchema` | object | Yes |  |
| `AuthoringSchemaResponse.validationNotes` | array of string | No |  |
| `AuthoringSchemaResponse.authoringGuidelines` | array of string | No |  |
| `AuthoringSchemaResponse.authoringWorkflow` | array of string | No |  |

**Nested field: `AuthoringSchemaResponse.validationNotes`**

**Array item: `AuthoringSchemaResponse.validationNotes[]`**

Type: string.

**Nested field: `AuthoringSchemaResponse.authoringGuidelines`**

**Array item: `AuthoringSchemaResponse.authoringGuidelines[]`**

Type: string.

**Nested field: `AuthoringSchemaResponse.authoringWorkflow`**

**Array item: `AuthoringSchemaResponse.authoringWorkflow[]`**

Type: string.


### schema validation error

**ValidationError**


Required properties: `error`.

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| `ValidationError.error` | string | Yes |  |
| `ValidationError.message` | string | No |  |
| `ValidationError.details` | array of object | No |  |
| `ValidationError.planLimits` | object | No | Present on render validation errors; contains the authenticated user's current render limits. |

**Nested field: `ValidationError.details`**

**Array item: `ValidationError.details[]`**

Unknown properties are rejected. Required properties: `field`, `message`.

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| `ValidationError.details[].field` | string | Yes |  |
| `ValidationError.details[].message` | string | Yes |  |


### schema authentication error

**AuthenticationError**


Unknown properties are rejected. Required properties: `error`.

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| `AuthenticationError.error` | string | Yes | Error type |
| `AuthenticationError.message` | string | No | Human-readable error message |


### schema error

**Error**


Required properties: `error`.

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| `Error.error` | string | Yes | Error type |
| `Error.message` | string | No | Human-readable error message |


## Related resources

- [OpenAPI specification](https://docs.zvid.io/openapi.yaml)
- [Project payload schema](https://docs.zvid.io/schemas/render-payload.schema.json)
- [Quick Start](https://docs.zvid.io/docs/quick-start/)
- [Authentication guide](https://docs.zvid.io/docs/authentication/)