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 /latest/avatar endpoint using your fictional API key sk-123456, you would include the following header:

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

​

Testing Authentication

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

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

​

Endpoint Versioning

All Beyond Presence API endpoints are versioned, and you can specify a specific version in your requests to ensure the endpoint interface stays consistent:

curl "https://api.bey.dev/{version}/{endpoint}"

For example, you can use the following command to call API version 1 of the GET avatar endpoint specifically:

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

Currently, we support the following versions:

• https://api.bey.dev/v1/ -> Version 1 of our API endpoints. Interface will stay stable if you specify this, even if we release new versions.
• https://api.bey.dev/latest/ -> Latest version of our API endpoints. Currently same as /v1/, but the interface might change as we release newer versions.

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

curl "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: