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

> Reference documentation for The Prompting Company public 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.

The Prompting Company public API reference describes routes marked
`visibility: "public"`. The application serves its OpenAPI document at
`https://app.promptingco.com/api/v1/openapi.json`. Mintlify renders the checked-in
`api-reference/openapi.json` snapshot as endpoint pages with request parameters,
response schemas, authentication, and examples. See [API reference](https://docs.promptingcompany.com/api/reference.md)
for the snapshot regeneration workflow.

## Base URL

```txt theme={null}
https://app.promptingco.com
```

Local development uses `http://localhost:3000`.

## Response format

Successful responses use the shared API envelope:

```json theme={null}
{
  "ok": true,
  "data": {}
}
```

Errors use:

```json theme={null}
{
  "ok": false,
  "code": "FORBIDDEN",
  "message": "public_api_only",
  "details": {}
}
```

> [card] [Authentication](https://docs.promptingcompany.com/api/authentication.md)
>
> Learn how API keys should be sent with requests.

> [card] [Scope reference](https://docs.promptingcompany.com/api/scopes.md)
>
> Review the permissions available for org-scoped API keys.


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