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

# API Deprecation Policy

> How Beyond Presence deprecates REST API endpoints, how deprecations are announced, and how long deprecated endpoints keep working.

When we retire an endpoint, we make the transition as predictable as possible.

## What Deprecation Means

A deprecated endpoint has been superseded by a newer one, usually because it was renamed or improved in a way that is not backwards compatible. Deprecated endpoints:

* **Keep working** exactly as before until their end-of-life date. Your existing integration does not break when an endpoint is deprecated.
* **Are hidden from the [API reference](/api-reference)**, which only documents the current endpoints.
* **Receive no new features.** New functionality is only added to the current endpoints.

## How Deprecations Are Announced

Every response from a deprecated endpoint, including error responses, carries the following headers:

| Header | Description |
| - | - |
| `Deprecation` | The date the deprecation took effect, as a Unix timestamp prefixed with `@` ([RFC 9745](https://www.rfc-editor.org/rfc/rfc9745)). |
| `Link` | The URL of the endpoint replacing the deprecated one, with `rel="successor-version"`. |
| `Sunset` | The end-of-life date after which the deprecated endpoint stops working ([RFC 8594](https://www.rfc-editor.org/rfc/rfc8594)). Returned once the date is scheduled. |

For example, a request to the deprecated `/v1/avatar` path returns:

```http theme={null}
Deprecation: @1789344000
Link: <https://api.bey.dev/v1/avatars>; rel="successor-version"
```

We recommend logging a warning whenever your client receives a `Deprecation` header so you notice deprecations early. In addition, we notify affected customers directly ahead of any end-of-life date.

## Migrating

To migrate, replace the deprecated path prefix in your requests with the one in the `Link` header and keep the rest of the path unchanged. For example, `GET /v1/avatar/{id}` becomes `GET /v1/avatars/{id}`. Successor endpoints are documented in the [API reference](/api-reference). If you need help with a migration or more time to complete it, reach out to us at [support@beyondpresence.ai](mailto:support@beyondpresence.ai).


## Related topics

- [API Versioning](/concepts/api/versioning.md)
- [Knowledge Base](/concepts/agents/knowledge-base.md)
- [Changelog](/learn/changelog.md)
- [API Errors](/concepts/api/errors.md)
- [Verify API Key](/api-reference/authentication/verify-api-key.md)


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