# OpenAPI Description

The public OpenAPI 3.1 document for the Hungry Machines API — download it or point a code generator at it.

Everything in this API Reference section is also published as one machine-readable file: [`openapi.json`](https://docs.hungrymachines.io/openapi.json), an OpenAPI 3.1 document generated from the API's code.

- [Download the OpenAPI description](/openapi.json): openapi.json — the full public specification.

## What it covers

The file lists every public route under `/auth` and `/api/v1` — the same routes documented on the pages in this section. Internal and partner-only routes are left out.

## Where the descriptions and examples come from

Every summary, description, and request/response example in the file comes from the same written contract this site's prose is built from, not from the API's internal source comments. A route with no response example yet says so rather than guessing one.

## Building a client from it

An OpenAPI 3.1 document is the standard input for most OpenAPI-to-client generators. Point one at the file above and it produces request/response types and a thin client in your language, so you don't have to hand-write them from this page.

## Discovery

The API host itself points back here, so a client that only has the bare
address can still find everything above: `GET /` on the API returns its
name, version and links to this spec, these docs and `/health`; `GET
/llms.txt` on the API redirects to [the docs site's
`llms.txt`](/llms.txt); and `GET /.well-known/api-catalog` serves the same
links as a standard RFC 9727 link-set document.

## Next steps

- [For Developers](/for-developers/) — the integration overview
- [Build your own client](/guides/build-your-own-client/) — hand-written examples in Python and JavaScript
- [Authentication](/getting-started/authentication/) — token lifecycle reference

Canonical page: https://docs.hungrymachines.io/api-reference/openapi/