API reference

The reference pages on the left are generated from openapi.yaml — the same spec the backend serves. They include an interactive Try it console so you can fire a real request against the API without leaving the docs.

Base URL

https://api.kynva.ai

Need a different region? Email support@kynva.ai.

Required headers

Every request must include:

Header	Example	Notes
`Authorization`	`Bearer kyn_live_...`	API key or JWT. See authentication.
`X-API-Version`	`2026-01-01`	Pin the response shape. See versioning.

POST/PATCH mutations also accept:

Header	Example	Notes
`Idempotency-Key`	UUID v4	Safe retry. See idempotency.

Response envelope

Successful responses are endpoint-specific — see each page. Errors always use the standard envelope.

Standard response headers

Header	Notes
`X-Request-Id`	Unique per request. Include in any support email.
`X-RateLimit-Remaining`	Calls left in this category. See rate limits.
`X-RateLimit-Reset`	Unix timestamp when the window resets.
`X-Idempotency-Status`	`stored` (first time) or `cached` (replay).

Tags

Endpoints are grouped by tag in the OpenAPI spec; the left nav mirrors that grouping. The major surfaces:

Tag	What it covers
Generate / Render Now	Single-call render of a brief or signed URL.
Drafts	Stateful workflow: create draft → set brief → compile → preview → render.
Render Jobs	Async batch renders. List, get, cancel, retry.
Brands / BrandKits	CRUD for brand identity and versioned BrandKits.
Assets	Upload, register, list, delete files used in briefs.
Webhooks	Subscribe to events, manage delivery, replay from DLQ.
Templates / Validation / Compile / Licenses (Advanced)	Power-user endpoints for managing your own Spec pipeline.
Reference	Static lookup endpoints (export profiles, API versions).
System	Health checks.

​Base URL

​Required headers

​Response envelope

​Standard response headers

​Tags

Base URL

Required headers

Response envelope

Standard response headers

Tags