---
title: "Get authoring example"
method: GET
path: "/api/render/examples/{name}/api-key"
tags: ["Authoring"]
---

# Get authoring example

`GET /api/render/examples/{name}/api-key`

## Request

- Base URL: `https://api.zvid.io`
- URL: `https://api.zvid.io/api/render/examples/{name}/api-key`
- Auth: API key in header `x-api-key`

Free named starter payload or request.

## Path parameters

- `name` 'promo-video' | 'template-render' | 'still-image' | 'subtitles' | 'webhook-flow', required

## Response `200`

Successful response

- ExampleResponse
  - `schemaVersion` string
  - `sourceOfTruth` string
  - `planLimits` object, required
  - `example` AuthoringExample, required
    - `name` string, required
    - `title` string
    - `description` string
    - `payload` RenderPayload (unresolved $ref)
    - `request` object

## 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)