> ## Documentation Index
> Fetch the complete documentation index at: https://docs.promptingcompany.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API reference

> OpenAPI-generated endpoint reference for the TPC API.

# API reference

<Warning>
  The TPC API is in alpha development. If you're interested in using it for a
  production use case, contact [support@promptingco.com](mailto:support@promptingco.com)
  to discuss your requirements.
</Warning>

Mintlify generates the endpoint reference from the checked-in `api-reference/openapi.json` snapshot configured in `docs.json`. You can download the published snapshot at:

```text theme={null}
https://docs.promptingcompany.com/api-reference/openapi.json
```

Mintlify renders endpoint pages under `api/reference`, including the request parameters, response schemas, authentication requirements, and client snippets present in the snapshot.

The snapshot must be regenerated and deployed with the docs when public route metadata changes. From the repository root, run `bun docs:openapi` and commit any changes to `apps/docs/api-reference/openapi.json`. A docs deployment does not fetch the live application spec automatically.

The application serves a spec generated from its deployed public route metadata at:

```text theme={null}
https://app.promptingco.com/api/v1/openapi.json
```

If you are running docs locally and need to test against a local client app, point the OpenAPI source at:

```text theme={null}
http://localhost:3000/api/v1/openapi.json
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.