> ## 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.

# Beyond Presence REST API

> Manage avatars, agents, conversations, external APIs, and speech-to-video sessions with the Beyond Presence REST API and x-api-key auth.

The Beyond Presence API provides direct programmatic access to our platform, allowing you to build custom video agent experiences and integrate our technology into your applications.

## API Features

The API enables you to:

* **Manage avatars**: List available avatars and access avatar details
* **Control agents**: Create, configure, update, and delete video agents
* **Monitor conversations**: Access conversation metadata and transcripts
* **Configure integrations**: Set up external API connections and webhooks
* **Start speech-to-video sessions**: Initiate real-time speech-to-video sessions

Complete documentation for all REST endpoints is available in our [API reference](https://docs.bey.dev/api-reference.md).

For speech-to-video sessions, use our [LiveKit plugin](https://docs.bey.dev/integrations/voice-agents/livekit.md) rather than calling the session endpoints directly.

## Authentication

Generate API keys in your [Studio settings](https://bey.studio/settings/api-keys).
Include your key in the `x-api-key` header with all requests:

```sh theme={null}
curl "https://api.bey.dev/v1/avatars" \
  --header 'x-api-key: sk-your-api-key-here'
```

To check in isolation whether your API key works, call the [Verify API Key](https://docs.bey.dev/api-reference/authentication/verify-api-key.md) endpoint.

## Learn More

> [card] [API Reference](https://docs.bey.dev/api-reference.md)
>
> Complete documentation for all API endpoints

> [card] [API Errors](https://docs.bey.dev/concepts/api/errors.md)
>
> Understand API error responses and status codes

> [card] [Quotas](https://docs.bey.dev/production/concurrency.md)
>
> API concurrency and usage limits that apply to your plan


## Related topics

- [API Errors](https://docs.bey.dev/concepts/api/errors.md)
- [API Versioning](https://docs.bey.dev/concepts/api/versioning.md)
- [API Deprecation Policy](https://docs.bey.dev/concepts/api/deprecation.md)
- [Glossary](https://docs.bey.dev/learn/glossary.md)
- [Privacy & GDPR](https://docs.bey.dev/production/privacy.md)


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