Machine-Readable OpenAPI Spec

The official Ziptax API specification is published in OpenAPI v3 JSON format and is always available at the URL below. This document is the authoritative source of truth for every endpoint, authentication method, request parameter, response schema, and error code in the Ziptax platform.

What you can do with it

The spec is designed for both humans and autonomous tooling:

• Load it into Swagger UI, Redoc, or Postman to explore the API interactively.
• Feed it to openapi-generator or any SDK generator to produce a type-safe client in your language of choice.
• Hand it to an AI agent or LLM that needs to understand request structure, authentication headers (X-API-KEY), and response shape before generating integration code.
• Use it to power contract tests against your own integration.

Authentication

All endpoints described in the spec authenticate via a single header:

1
X-API-KEY: your-api-key

Some endpoints additionally accept the API key as a key= query parameter, but the header is preferred for production use.