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

# API overview

> Project-scoped HTTP endpoints with a generated OpenAPI reference.

The API base URL for the current development environment is:

```text theme={null}
https://api.dev.postinger.dev/public/v1
```

Authenticate with a project customer key in the `Authorization: Bearer` header. Every request is scoped to that key's project; you do not pass a project ID.

## Response format

Successful responses use:

```json theme={null}
{
  "data": {},
  "meta": { "requestId": "request-identifier" }
}
```

`data` varies by operation; each endpoint page describes its complete shape. Errors normally contain `error.code`, `error.message`, and `meta.requestId`. Oversized requests rejected before the controller can have a different format.

## OpenAPI

[Download the OpenAPI document](/api-reference/openapi.json). The endpoint reference is generated from the same specification builder as the backend. The checked-in snapshot keeps these docs reproducible and is checked against source in CI.

The running backend also serves [its deployed OpenAPI document](https://api.dev.postinger.dev/public/openapi.json). A deployment that has not yet caught up with this source snapshot can show an older contract.

The interactive request builder sends real requests to the selected server. Use your own project key and review write operations before sending them.

<CardGroup cols={2}>
  <Card title="Make your first request" href="/api-reference/quickstart" icon="bolt">Verify a key and create a draft.</Card>
  <Card title="Authentication and permissions" href="/guides/authentication" icon="key">Choose the access your integration needs.</Card>
</CardGroup>


## Related topics

- [API quickstart](/api-reference/quickstart.md)
- [Verify API credentials and inspect project, expiry and effective permissions](/api-reference/authentication/verify-api-credentials-and-inspect-project-expiry-and-effective-permissions.md)
- [Authentication and permissions](/guides/authentication.md)
- [Your first draft](/quickstart.md)
- [CLI authentication](/cli/authentication.md)


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