실시간 API

POST

/v1/realtime/sessions

POST

/v1/realtime/sessions

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"
  }
}

수명이 짧은 실시간 API 브라우저 세션을 만들고 BeatAPI 실시간 SDK용 클라이언트 시크릿을 받습니다.

신뢰할 수 있는 서버에서 세션을 만들고, 브라우저에는 client_secret만 전달하고, @beatapi/realtime으로 연결한 뒤, 사용이 끝나면 세션을 종료하세요. 보안과 수명 주기 체크리스트는 빠른 시작을 참고하세요.

인증

AuthorizationBearer

API 키를 Authorization: Bearer <BEATAPI_API_KEY>로 보내세요.

요청

This endpoint expects an object.

max_duration_secondsenum필수

필수인 라이브 세션 최대 길이(초)입니다. 선택한 15, 60 또는 300초 등급의 USD 금액이 보류됩니다.

허용된 값:

allowed_originslist of strings필수

수명이 짧은 세션 시크릿을 사용할 수 있는 정확한 브라우저 출처입니다.

metadatamap from strings to strings선택 사항

자체 상관관계 추적을 위한 선택적 서버 정의 문자열 메타데이터입니다. 키는 최대 20개, 키는 최대 64자, 값은 최대 256자입니다.

응답

실시간 세션 생성됨

dataobject

1회용 단기 브라우저 자격 증명을 포함해 생성된 Realtime 세션입니다.

오류

400

Bad Request Error

401

Unauthorized Error

402

Payment Required Error

409

Conflict Error

429

Too Many Requests Error

503

Service Unavailable Error

인증

헤더

요청

응답

오류