Skip to main content

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.

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 calls: 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. For speech-to-video sessions, use our LiveKit plugin or Pipecat service rather than calling the session endpoints directly.

​
Authentication

Generate API keys in your dashboard settings. Include your key in the x-api-key header with all requests: 
curl "https://api.bey.dev/v1/avatars" \
  --header 'x-api-key: sk-your-api-key-here'

​
Next Steps

Dashboard

Generate API keys, deploy agents on the fly, and more

Integrations

Discover the available integrations

API Reference

Complete documentation for all endpoints