Realtime API | BeatAPI API Documentation

curl -X POST https://api.beatapi.io/v1/realtime/sessions \
     -H "Idempotency-Key: rts-create-cus_123-01" \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "max_duration_seconds": 60,
  "allowed_origins": [
    "https://app.example.com"
  ],
  "metadata": {
    "customer_id": "cus_123"
  }
}'

{
  "data": {
    "id": "rts_8K2qA",
    "object": "realtime.session",
    "status": "ready",
    "expires_at": "2026-08-12T10:01:00.000Z",
    "max_duration_seconds": 60,
    "allowed_origins": [
      "https://app.example.com"
    ],
    "credits": {
      "reserved": 1.2,
      "settled": 0,
      "refunded": 0
    },
    "request_id": "req_abc123",
    "created_at": "2026-08-12T10:00:00.000Z",
    "connected_at": null,
    "closed_at": null,
    "client_secret": "brt_live_example_short_lived_secret"
  }
}

Создайте краткоживущую браузерную сессию Realtime API и получите клиентский секрет для SDK реального времени BeatAPI.

Создавайте сессию на доверенном сервере, передавайте в браузер только client_secret, подключайтесь через @beatapi/realtime и закрывайте сессию по окончании работы. Проверки безопасности и жизненного цикла приведены в быстром старте.

Аутентификация

AuthorizationBearer

Передавайте API-ключ в виде Authorization: Bearer <BEATAPI_API_KEY>.

Запрос

This endpoint expects an object.

max_duration_secondsenumОбязательный

Обязательная максимальная длительность сессии в секундах. Сумма в USD резервируется для выбранного тарифа на 15, 60 или 300 секунд.

Допустимые значения:

allowed_originslist of stringsОбязательный

Точные origin браузера, которым разрешено использовать краткоживущий секрет сессии.

metadatamap from strings to stringsОпциональный

Необязательные строковые метаданные, заданные сервером для вашей корреляции. До 20 ключей; ключи до 64 символов, значения до 256 символов.

Ответ

Сессия реального времени создана

dataobject

Созданная Realtime Session с одноразовыми краткоживущими учётными данными для браузера.

Ошибки

400

Bad Request Error

401

Unauthorized Error

402

Payment Required Error

409

Conflict Error

429

Too Many Requests Error

503

Service Unavailable Error

Аутентификация

Заголовки

Запрос

Ответ

Ошибки