Realtime API

POST https://api.beatapi.io/v1/realtime/sessions

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

Авторизация

Authorization   string   обязательный

Передавайте API-ключ BeatAPI как токен Bearer. Создать ключ можно в панели управления.

Authorization: Bearer <BEATAPI_API_KEY>

Храните постоянные API-ключи на доверенных серверах. Для тела запроса обязателен Content-Type: application/json. Если метод принимает Idempotency-Key, этот заголовок необязателен, но рекомендуется для безопасных повторных попыток с точно таким же телом.

Тело запроса

max_duration_seconds   enum<integer>   обязательный

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

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

allowed_origins   string[]   обязательный

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

Количество: 1 – 10 элементов

metadata   object   необязательный

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

Ответ

Успешный запрос возвращает HTTP 201.

{
  "data": {
    "id": "rts_8K2qA",
    "object": "realtime.session",
    "status": "ready",
    "client_secret": "brt_live_example_short_lived_secret",
    "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
  }
}

Подключение в браузере

Установите браузерный SDK:

npm install @beatapi/realtime

import { createRealtimeClient } from '@beatapi/realtime';
const camera = await navigator.mediaDevices.getUserMedia({ video: true });
const output = document.querySelector<HTMLVideoElement>('#output')!;
const client = createRealtimeClient({ clientSecret: session.client_secret });
const connection = await client.connect({
  input: camera,
  output,
  initial: { prompt: 'Preserve motion while applying the requested style.' },
});

Передавайте только краткоживущий client_secret на точный origin из allowed_origins. Стоимость выбранной длительности резервируется при создании сессии и списывается только после того, как первый удалённый выходной кадр вызовет принятый BeatAPI сигнал биллинга.

• GET /v1/realtime/sessions/{session_id} возвращает сведения о сессии Realtime.
• DELETE /v1/realtime/sessions/{session_id} закрывает сессию Realtime.

После окончания работы разорвите браузерное соединение, остановите локальные медиадорожки и закройте серверную сессию.

Следующий шаг

Передайте полученный client_secret в @beatapi/realtime. Постоянный API-ключ храните на доверенном сервере. После окончания работы в браузере закройте сессию.

Ошибки