# API reference (https://docs.getbeel.com/en/api/reference)

Every endpoint, generated from the OpenAPI document, with the playground.

These pages are generated from the API's OpenAPI 3.1 document, so they always match the code. Download the document from [`/openapi.json`](https://docs.getbeel.com/openapi.json) to generate clients and SDKs.

## Playground [#playground]

Every page has a playground to try the request from your browser. Requests go through a proxy on this site, which only forwards to the Getbeel API and does not log bodies.

<Callout type="warn" title="Use a test key">
  In the `Authorization` field enter `Bearer gb_test_…`. The playground runs in
  your browser: don't paste a live key into it.
</Callout>

## Conventions [#conventions]

- Base URL: `https://www.getbeel.com/api/v1`.
- Authentication: [API key](/en/api/authentication) in the `Authorization` header.
- Errors: [common shape](/en/api/errors) `{ "error": { type, code, message, param } }`.
- Lists: [cursor pagination](/en/api/pagination).
- `POST` requests that create or send: [`Idempotency-Key`](/en/api/idempotency) header.
