OpenAPI Spec & Postman

The entire public API is described by a single OpenAPI 3.1 document. Download it to explore endpoints in Postman or Insomnia, generate a typed client, or drive your own tooling — no copy-pasting from these docs required.

Download

• Download OpenAPI spec (YAML) — recommended
• Download OpenAPI spec (JSON)

The spec covers only the public endpoints:

Method	Path	Purpose
GET	/api/v1/projects	List your projects
GET	/api/v1/projects/{projectId}/templates	List templates in a project
GET	/api/v1/templates/{templateId}	Inspect a template and its variable schema
POST	/api/v1/templates/{templateId}/generate	Render a personalized image

The document’s servers block is set to https://app.zandovi.com, and every operation declares the X-Api-Key API-key security scheme — so imported requests are pre-wired with the right base URL and auth.

Import into Postman

1. Open Postman → Import (top-left), then drag in zandovi-openapi.yaml (or File → Choose Files).
2. Postman creates a Zandovi API collection with every endpoint and example request, and detects the X-Api-Key auth from the spec.
3. Open the collection → Variables (or its Authorization tab) and set your API key once — every request inherits it.
4. Create your key first in Settings → API Keys — see Authentication.

Ready to send

Because the spec ships with https://app.zandovi.com as the server and X-Api-Key as the security scheme, imported requests only need your key filled in before you hit Send.

Import into Insomnia or generate a client

• Insomnia: Create → Import From File → pick the YAML. Same result.

• Client generation: feed the file to any OpenAPI 3.1 tool, e.g.

  # TypeScript types
  npx openapi-typescript zandovi-openapi.yaml -o zandovi.d.ts
  
  # A full client with openapi-generator
  openapi-generator generate -i zandovi-openapi.yaml -g python -o ./zandovi-client

What’s not in the spec

Admin, billing, and internal endpoints are intentionally excluded — the document contains only the render-focused public API described in these docs. Batch generation is not part of the public API; render in bulk by looping the generate endpoint, or use the in-app batch tools.

Staying current

The spec is regenerated from the API itself, so the download tracks the live https://app.zandovi.com/api/v1 behavior. Pin against the info.version field inside the file if you need to detect changes.