> This page is for version v5.0.
> For other versions, use one of these documentation indexes:
> - v6.0 (default): https://docs.zip.tax/v-6-0/llms.txt
> - v5.0: https://docs.zip.tax/v-5-0/llms.txt

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.zip.tax/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.zip.tax/_mcp/server.

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

#### [openapi.json](https://raw.githubusercontent.com/ZipTax/ziptax-reference/main/openapi/openapi.json)

Canonical machine-readable spec. Always up to date.

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

```http
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.

> **Info**
>
> The spec is regenerated automatically from the Ziptax API source of truth,
> so bookmarking the raw URL above guarantees you always have the latest
> contract.