OpenAPI specification

The whole reference is also available as an OpenAPI 3.1 document, generated from the same source as these pages so the two never disagree.

https://vitruve-docs-prod.web.app/openapi.json

Use itCopy Anchor Link

• Postman or Insomnia: import the URL as an OpenAPI collection, then set an X-API-Key header or the API key authorization.
• Generate a client: feed the file to a generator such as openapi-generator or openapi-typescript.
• Validate responses: use the examples as fixtures in your tests.

What it containsCopy Anchor Link

• Every endpoint, its method, path and query parameters, with types, enums and defaults.
• The JSON request body of every write, with its required fields, and the optional Idempotency-Key header of every create.
• The X-API-Key security scheme.
• The shared error responses.
• A realistic example response for each endpoint.

Response bodies are described by example rather than by full JSON schemas: entities are Prisma rows returned as stored, and the reference lists the fields you can rely on. Generated clients should treat bodies as loosely typed and ignore unknown fields.

Partner platforms have their own document, limited to the endpoints they can call: see Partner OpenAPI.