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

# API reference

> Base URL, authentication, versioning and conventions for every endpoint.

## Base URL

```
https://api.usecerium.com/v1
```

All requests use HTTPS. Request and response bodies are JSON. Set `Content-Type: application/json` on requests with a body.

## Authentication

```
Authorization: Bearer <your API key>
```

See [Authentication](/authentication.md) for scopes. Each endpoint page names the scope it needs.

## Endpoints

| Resource | Endpoints |
| - | - |
| **Customers** | Create or get, list, get, update, erase |
| **Conversations** | Start, list, get, close or reopen |
| **Messages** | List, send |

## Responses

```json
{
  "message": "Conversations retrieved successfully.",
  "status": "success",
  "data": [],
  "meta": {}
}
```

Errors return a non-2xx status with a `message` and often a `code`. See [Errors](/guides/errors.md).

## Versioning

The version is in the path (`/v1`). Within a version we only make changes that do not break your integration, such as adding an endpoint or a response field. **Ignore fields you do not recognise** so those additions never break you. A breaking change is released as a new version, and announced in the [changelog](/changelog.md) first.

## Conventions

* Timestamps are ISO 8601 in UTC.
* Ids are opaque strings.
* Empty values are `null`.
* Lists are newest first. See [Pagination](/guides/pagination.md).

## Try it

Each endpoint page has a playground. Enter your key under **Authorization**, fill in the parameters and send a request.

> [!WARNING]
>
> The playground sends **real requests** with your key. Prefer a key that is limited to the scopes you are testing.
