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

# API overview

> Learn the OpenPMM API base URL, request rules, response format, and versioning.

The OpenPMM API uses JSON over HTTP.

```text theme={null}
https://api.openpmm.com/v1
```

The endpoint reference uses the OpenAPI document from the production API. OpenPMM refreshes the reference after a successful production deployment.

## Conventions

* Send the API key as a bearer token except during signup and CLI browser authorization.
* Send and receive JSON unless an upload endpoint gives different instructions.
* Use IDs without changes.
* Send `Idempotency-Key` when the endpoint requires it.
* Send `If-Match` when the endpoint requires an ETag.
* Send `confirmed: true` for an action that can publish.

## Versioning

The `/v1` prefix identifies this API version. OpenPMM can add response fields without a new version. Ignore response fields that your application does not use.