---
title: "Get live render schema"
method: GET
path: "/api/render/schema/api-key"
tags: ["Authoring"]
---

# Get live render schema

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

## Request

- Base URL: `https://api.zvid.io`
- URL: `https://api.zvid.io/api/render/schema/api-key`
- Auth: API key in header `x-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.

## Query parameters

- `target` 'project' | 'render-request'

## Response `200`

Successful response

- AuthoringSchemaResponse
  - `schemaVersion` string, required
  - `sourceOfTruth` string
  - `planLimits` object, required
  - `target` 'project' | 'render-request', required
  - `jsonSchema` object, required
  - `validationNotes` string[]
  - `authoringGuidelines` string[]
  - `authoringWorkflow` string[]

## Other responses

- `400`: Invalid input or semantic validation error
- `401`: Missing or invalid credentials
- `404`: Not found for this account
- `500`: Server error

---

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