relay

Register Relay Instance

Register a relay client and return a short-lived relay token.

The relay token is used to authenticate the client's WebSocket connection to the session relay channel.

post/api/v1/relay/register

Request

  • Base URL: https://docs.omnara.com (the document declares no server; this is the origin it was published from)
  • URL: https://docs.omnara.com/api/v1/relay/register
  • Auth: HTTP bearer

Request body

user_session_idstring required

Identifier of the user session the relay client will operate within.

client_kind'cli' | 'web' | 'mobile' | 'voice'

Type of client connecting to the relay.

Response

Successful Response

user_session_idstring required

Identifier of the user session scoped to this relay token.

relay_tokenstring required

Short-lived relay token for websocket authentication.

relay_token_expires_ininteger required

Seconds until the relay token expires.

relay_ws_pathstring required

WebSocket path for the relay endpoint.

relay_heartbeat_interval_secinteger required

Heartbeat interval clients should respect.

Changes

No recorded changes to this operation across all 1 revision of this API.