> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.beatapi.io/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.beatapi.io/_mcp/server.

# Realtime API

POST https://api.beatapi.io/v1/realtime/sessions
Content-Type: application/json

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

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

Reference: https://docs.beatapi.io/api-reference/realtime-api

## Authentication

- `Authorization` header (bearer token, required) — Передавайте API-ключ в виде `Authorization: Bearer <BEATAPI_API_KEY>`.

## Servers

- `https://api.beatapi.io` (Direct, default)
- `https://api.beatapi.io` (API)

## Request

### Headers

- `Idempotency-Key` (string, required)

### Body (application/json)

This endpoint expects an object.

- `max_duration_seconds` (enum, required) — Обязательная максимальная длительность сессии в секундах. Сумма в USD резервируется для выбранного тарифа на 15, 60 или 300 секунд.
  - Allowed values: `15`, `60`, `300`
- `allowed_origins` (list of string, required) — Точные origin браузера, которым разрешено использовать краткоживущий секрет сессии.
- `metadata` (map from string to string, optional) — Необязательные строковые метаданные, заданные сервером для вашей корреляции. До 20 ключей; ключи до 64 символов, значения до 256 символов.

## Response

### 201

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

- `data` (RealtimeSessionCreated, required) — Созданная Realtime Session с одноразовыми краткоживущими учётными данными для браузера.

## Errors

### 400 Bad Request Error

Некорректный JSON либо недопустимое поле, значение или сочетание для этого эндпоинта (`bad_request`; сообщение называет поле), либо отклонение модерацией (`content_policy_violation`). Повтор без изменений не допускается.

- `error` (ErrorError, required) — Структурированная ошибка BeatAPI. Используйте `code` (или `retryable`) в логике программы и сохраняйте `request_id` для обращения в поддержку.

### 401 Unauthorized Error

Нет API-ключа (`missing_api_key`) либо ключ неверен, истёк, отключён или исчерпан (`invalid_api_key`; причина указана в сообщении). Передайте его как `Authorization: Bearer <key>`; ключ работает как с префиксом `sk-`, так и без него. Повтор не допускается.

- `error` (ErrorError, required) — Структурированная ошибка BeatAPI. Используйте `code` (или `retryable`) в логике программы и сохраняйте `request_id` для обращения в поддержку.

### 402 Payment Required Error

Недостаточный баланс (`insufficient_credits`). Баланс аккаунта нулевой или ниже цены запроса. Пополните его и отправьте запрос снова; до этого повтор не допускается.

- `error` (ErrorError, required) — Структурированная ошибка BeatAPI. Используйте `code` (или `retryable`) в логике программы и сохраняйте `request_id` для обращения в поддержку.

### 409 Conflict Error

`Idempotency-Key` уже использован с другим телом или путём запроса в течение 24 часов, либо первый запрос ещё выполняется (`idempotency_conflict`). Повтор без изменений не допускается.

- `error` (ErrorError, required) — Структурированная ошибка BeatAPI. Используйте `code` (или `retryable`) в логике программы и сохраняйте `request_id` для обращения в поддержку.

### 429 Too Many Requests Error

Слишком много запросов (`rate_limit_exceeded`, включая ограничения бесплатных моделей). Повтор допустим через количество секунд из `Retry-After` (также `error.retry_after_seconds`).

- `error` (ErrorError, required) — Структурированная ошибка BeatAPI. Используйте `code` (или `retryable`) в логике программы и сохраняйте `request_id` для обращения в поддержку.

### 503 Service Unavailable Error

Realtime Video не включён в этой среде (`realtime_disabled`, повтор не допускается; самостоятельно включить нельзя, обратитесь в поддержку) либо временно нет свободных ресурсов (`realtime_capacity_unavailable`, повтор допустим; повторите вскоре с увеличивающейся задержкой, конкретная задержка не указана).

- `error` (ErrorError, required) — Структурированная ошибка BeatAPI. Используйте `code` (или `retryable`) в логике программы и сохраняйте `request_id` для обращения в поддержку.

## Types

### RealtimeSessionCreated

- `id` (string, required) — Стабильный идентификатор Realtime Session для просмотра и закрытия сессии.
- `object` (enum, required) — Дискриминатор объекта; всегда `realtime.session`.
  - Allowed values: `realtime.session`
- `status` (enum, required) — Active означает, что BeatAPI принял первое тарифицирующее heartbeat-сообщение после начала удалённого вывода.
  - Allowed values: `ready`, `connecting`, `active`, `closed`, `failed`, `expired`
- `expires_at` (datetime, required) — Время истечения краткоживущих учётных данных сессии, к которой не подключились.
- `max_duration_seconds` (enum, required) — Выбранная максимальная длительность сессии и тариф в секундах.
  - Allowed values: `15`, `60`, `300`
- `allowed_origins` (list of string, required) — Точные origin браузера, которым разрешено использовать эту сессию.
- `credits` (RealtimeSessionCreatedCredits, required) — Жизненный цикл резервирования, окончательного списания и возврата USD для этой Realtime Session. Имена полей сохранены для совместимости.
- `request_id` (string, required) — Идентификатор корреляции для журналов и поддержки BeatAPI.
- `created_at` (datetime, required) — Время создания сессии.
- `connected_at` (datetime, required, nullable) — Время первого принятого тарифицирующего heartbeat-сообщения BeatAPI; null до активации тарификации.
- `closed_at` (datetime, required, nullable) — Время закрытия сессии или null, пока она открыта.
- `client_secret` (string, required) — Краткоживущие учётные данные BeatAPI для браузера, возвращаются только POST. Никогда не передавайте API-ключ sk_ в браузер.

### ErrorError

Структурированная ошибка BeatAPI. Используйте `code` (или `retryable`) в логике программы и сохраняйте `request_id` для обращения в поддержку.

- `code` (enum, required) — Стабильный машиночитаемый код ошибки. `unauthorized` — прежнее название ошибки 401; с 2026-09-29 при 401 возвращается `missing_api_key` или `invalid_api_key`, но `unauthorized` ещё может встречаться. Обрабатывайте его как `invalid_api_key`. `result_expired` возвращается только `POST /v1/capabilities/run` с `operation: "result"`.
  - Allowed values: `bad_request`, `missing_api_key`, `invalid_api_key`, `unauthorized`, `forbidden`, `not_found`, `insufficient_credits`, `idempotency_conflict`, `rate_limit_exceeded`, `content_policy_violation`, `processing_unavailable`, `processing_failed`, `processing_timeout`, `result_transfer_failed`, `result_expired`, `not_implemented`, `realtime_disabled`, `realtime_capacity_unavailable`, `realtime_session_expired`, `origin_not_allowed`, `invalid_client_secret`, `transport_not_allowed`, `internal_error`
- `message` (string, required) — Предложение на английском с причиной ошибки; для `bad_request` указывает поле. Предназначено для людей и журналов, а не для программного разбора.
- `request_id` (string, required) — Идентификатор корреляции, который нужно сохранить для поддержки BeatAPI.
- `retryable` (boolean, optional) — Может ли повтор того же вызова завершиться успешно. Присутствует для каждого кода публичной таблицы; может отсутствовать только для кода вне неё. True для rate_limit_exceeded, internal_error, processing_unavailable, processing_timeout, processing_failed, result_transfer_failed и realtime_capacity_unavailable. False, если сначала нужно изменить запрос, ключ или баланс (bad_request, content_policy_violation, missing_api_key, invalid_api_key, unauthorized, insufficient_credits, forbidden, not_found, idempotency_conflict, result_expired, not_implemented, realtime_disabled и остальные коды учётных данных realtime).
- `retry_after_seconds` (integer, optional) — Задержка перед повтором в секундах. Передаётся только при 429 `rate_limit_exceeded`; то же значение содержится в заголовке `Retry-After`. У других кодов отсутствует.
- `docs` (string, optional) — Публичная страница Skill с инструкциями по устранению ошибки. Присутствует в ошибках эндпоинтов возможностей (`/v1/capabilities/search`, `/v1/capabilities/inspect`, `/v1/capabilities/run`); у всех остальных отсутствует.

### RealtimeSessionCreatedCredits

Жизненный цикл резервирования, окончательного списания и возврата USD для этой Realtime Session. Имена полей сохранены для совместимости.

- `reserved` (double, required) — Сумма в USD, зарезервированная при создании сессии.
- `settled` (double, required) — Сумма в USD, окончательно списанная после первого принятого тарифицирующего heartbeat-сообщения.
- `refunded` (double, required) — Сумма в USD, возвращённая, если сессия завершилась до активации тарификации.

## Examples

**Request**

```json
{
  "max_duration_seconds": 60,
  "allowed_origins": [
    "https://app.example.com"
  ],
  "metadata": {
    "customer_id": "cus_123"
  }
}
```

**Response**

```json
{
  "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"
  }
}
```

**SDK Code**

```python Realtime API
import requests

url = "https://api.beatapi.io/v1/realtime/sessions"

payload = {
    "max_duration_seconds": 60,
    "allowed_origins": ["https://app.example.com"],
    "metadata": { "customer_id": "cus_123" }
}
headers = {
    "Idempotency-Key": "rts-create-cus_123-01",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript Realtime API
const url = 'https://api.beatapi.io/v1/realtime/sessions';
const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': 'rts-create-cus_123-01',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: '{"max_duration_seconds":60,"allowed_origins":["https://app.example.com"],"metadata":{"customer_id":"cus_123"}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Realtime API
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.beatapi.io/v1/realtime/sessions"

	payload := strings.NewReader("{\n  \"max_duration_seconds\": 60,\n  \"allowed_origins\": [\n    \"https://app.example.com\"\n  ],\n  \"metadata\": {\n    \"customer_id\": \"cus_123\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Idempotency-Key", "rts-create-cus_123-01")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Realtime API
require 'uri'
require 'net/http'

url = URI("https://api.beatapi.io/v1/realtime/sessions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = 'rts-create-cus_123-01'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"max_duration_seconds\": 60,\n  \"allowed_origins\": [\n    \"https://app.example.com\"\n  ],\n  \"metadata\": {\n    \"customer_id\": \"cus_123\"\n  }\n}"

response = http.request(request)
puts response.read_body
```

```java Realtime API
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.beatapi.io/v1/realtime/sessions")
  .header("Idempotency-Key", "rts-create-cus_123-01")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"max_duration_seconds\": 60,\n  \"allowed_origins\": [\n    \"https://app.example.com\"\n  ],\n  \"metadata\": {\n    \"customer_id\": \"cus_123\"\n  }\n}")
  .asString();
```

```php Realtime API
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.beatapi.io/v1/realtime/sessions', [
  'body' => '{
  "max_duration_seconds": 60,
  "allowed_origins": [
    "https://app.example.com"
  ],
  "metadata": {
    "customer_id": "cus_123"
  }
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
    'Idempotency-Key' => 'rts-create-cus_123-01',
  ],
]);

echo $response->getBody();
```

```csharp Realtime API
using RestSharp;

var client = new RestClient("https://api.beatapi.io/v1/realtime/sessions");
var request = new RestRequest(Method.POST);
request.AddHeader("Idempotency-Key", "rts-create-cus_123-01");
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"max_duration_seconds\": 60,\n  \"allowed_origins\": [\n    \"https://app.example.com\"\n  ],\n  \"metadata\": {\n    \"customer_id\": \"cus_123\"\n  }\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Realtime API
import Foundation

let headers = [
  "Idempotency-Key": "rts-create-cus_123-01",
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "max_duration_seconds": 60,
  "allowed_origins": ["https://app.example.com"],
  "metadata": ["customer_id": "cus_123"]
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.beatapi.io/v1/realtime/sessions")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```