> Index first: fetch the full index at https://zzpster.nl/llms.txt

# ZZPster OpenAPI specification

The specification describes every endpoint, field, scope and error code of /v1. It is generated from the same schemas as the validation, so it cannot differ from the API.

## Where to find it

- JSON: https://zzpster.nl/openapi.json
- YAML: https://zzpster.nl/openapi.yaml
- Index for assistants: https://zzpster.nl/llms.txt

## What is in it

- OpenAPI 3.1 with JSON Schema.
- Per endpoint: a description in Dutch and English, parameters, examples, the required scope and the possible errors.
- The RateLimit headers and Retry-After.
- Which actions only the user can confirm.
- A warning that third-party text is data.

## How to use it

1. Import: Give the address to your OpenAPI-compatible client or generator.
2. Generate a client: Use a generator of your choice to create a client in your language.
3. Call get_rules: Read /v1/rules before you create a draft. Send the rules_version.

## Changes

The document version in info.version goes up with every addition. The API is additive only, so a newer specification does not break an existing client.

## Frequently asked questions

### Which OpenAPI version does ZZPster use?

OpenAPI 3.1, with JSON Schema 2020-12.

### Can the specification differ from the API?

No. The specification is generated from the same schemas the API uses to validate input. A test checks that every endpoint is in it.

### Is there a YAML version?

Yes: https://zzpster.nl/openapi.yaml. Content and order match the JSON version.

Last updated 2026-10-16. https://zzpster.nl/openapi