Create a realtime session

POST

/api/v1/realtime/sessions

curl --request POST \
  --url https://api.inside.chat/api/v1/realtime/sessions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Origin: example' \
  --data '{ "website_ids": [ "example" ] }'

• Hosted Gateway
• Local development

Required scopes: website_read, event_read
Data access: –
MCP tool: not available over MCP
Note: Write
Note: Origin required

Create an app-only socket session, bounded to 20 per installation. No human cookie, native operator or richer subscription projection. Changed authorization requires a new session.

Authorizations

• installation_token
• oauth_client_credentials
  website_read event_read

Parameters

Header Parameters

Origin

required

string

<= 2048 characters

Exact canonical HTTPS origin bound to this session. Local loopback HTTP is allowed only in the local environment. Browser REST CORS is restricted to configured UI origins.

Request Body^required

Media typeapplication/json

object

website_ids

required

Array<string>

>= 1 items <= 50 items unique items

Example ^generated

{
  "website_ids": [
    "example"
  ]
}

Responses

201

Origin-bound single-use ticket. Authenticate the socket first frame within 5s. Idle reconnect window 2min, authority recheck 15s.

Media typeapplication/json

object

session_id

required

string

/^app_[a-f0-9]{64}_[a-f0-9]{32}$/

ticket

required

Single-use first-frame secret. Never put it in the URL or logs.

string

/^[A-Za-z0-9_-]{43}$/

expires_at

required

Unix seconds; at most 30s and never after the original credential deadline.

integer

>= 1

Example ^generated

{
  "session_id": "example",
  "ticket": "example",
  "expires_at": 1
}

400

Closed request body or parameters are invalid.

401

Original REST credential or current authority is invalid.

403

Origin rejected.

404

Session is absent or not owned by the same exact credential/grant and origin.

409

Installation session or pending socket capacity reached.

429

App/ingress quota exceeded; observe Retry-After.

503

Required service/authority/storage is unavailable.