API Introduction

​

Authentication

You can interact with the Beyond Presence Real-Time API through HTTP requests using your Beyond Presence API key.

See the API Keys section for more information on how to create and manage API keys.

​

Endpoint Authentication

All API endpoints are authenticated using using your API key. Each request should include an x-api-key header with your API key as value.

For example, to authenticate to the GET /v1/avatar endpoint using your fictional API key sk-123456, you would include the following header:

curl -X "https://api.bey.dev/v1/avatar" \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: "sk-123456"'

​

Testing Authentication

You can use the GET /v1/auth/verify endpoint to test in isolation whether the authentication with your API key works as expected:

curl -X "https://api.bey.dev/v1/auth/verify" \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: "sk-123456"'

​

API Reference

To get started with the API, see the API Reference section for more information on how to interact with each endpoint: