Observe a session

GET

/v1/sessions/{sessionId}/stream

• Production

Authenticated-fetch SSE: one snapshot (Snapshot), then coalesced update events (Update). A new snapshot follows lag. Expires after five minutes; disconnecting never cancels work. A shared session’s stream ends for its viewers as soon as it is no longer shared with them.

Authorizations

• bearerAuth

Parameters

Path Parameters

sessionId

required

string

Responses

200

SSE

string

400

Rejected; never contains credentials or upstream payloads.

object

error

required

object

code

required

Stable code, e.g. not_found, idempotency_conflict, session_working, usage_limit_exceeded. Open.

string

type

Category, e.g. invalid_request_error, authentication_error, usage_limit_error. Open.

string

message

string

host

Host_in_use: the host another service holds.

string

service

Host_in_use: the id of the service that holds the host.

string

401

Rejected; never contains credentials or upstream payloads.

object

error

required

object

code

required

Stable code, e.g. not_found, idempotency_conflict, session_working, usage_limit_exceeded. Open.

string

type

Category, e.g. invalid_request_error, authentication_error, usage_limit_error. Open.

string

message

string

host

Host_in_use: the host another service holds.

string

service

Host_in_use: the id of the service that holds the host.

string

403

Rejected; never contains credentials or upstream payloads.

object

error

required

object

code

required

Stable code, e.g. not_found, idempotency_conflict, session_working, usage_limit_exceeded. Open.

string

type

Category, e.g. invalid_request_error, authentication_error, usage_limit_error. Open.

string

message

string

host

Host_in_use: the host another service holds.

string

service

Host_in_use: the id of the service that holds the host.

string

404

Rejected; never contains credentials or upstream payloads.

object

error

required

object

code

required

Stable code, e.g. not_found, idempotency_conflict, session_working, usage_limit_exceeded. Open.

string

type

Category, e.g. invalid_request_error, authentication_error, usage_limit_error. Open.

string

message

string

host

Host_in_use: the host another service holds.

string

service

Host_in_use: the id of the service that holds the host.

string

409

Rejected; never contains credentials or upstream payloads.

object

error

required

object

code

required

Stable code, e.g. not_found, idempotency_conflict, session_working, usage_limit_exceeded. Open.

string

type

Category, e.g. invalid_request_error, authentication_error, usage_limit_error. Open.

string

message

string

host

Host_in_use: the host another service holds.

string

service

Host_in_use: the id of the service that holds the host.

string

410

Rejected; never contains credentials or upstream payloads.

object

error

required

object

code

required

Stable code, e.g. not_found, idempotency_conflict, session_working, usage_limit_exceeded. Open.

string

type

Category, e.g. invalid_request_error, authentication_error, usage_limit_error. Open.

string

message

string

host

Host_in_use: the host another service holds.

string

service

Host_in_use: the id of the service that holds the host.

string

411

Rejected; never contains credentials or upstream payloads.

object

error

required

object

code

required

Stable code, e.g. not_found, idempotency_conflict, session_working, usage_limit_exceeded. Open.

string

type

Category, e.g. invalid_request_error, authentication_error, usage_limit_error. Open.

string

message

string

host

Host_in_use: the host another service holds.

string

service

Host_in_use: the id of the service that holds the host.

string

413

Rejected; never contains credentials or upstream payloads.

object

error

required

object

code

required

Stable code, e.g. not_found, idempotency_conflict, session_working, usage_limit_exceeded. Open.

string

type

Category, e.g. invalid_request_error, authentication_error, usage_limit_error. Open.

string

message

string

host

Host_in_use: the host another service holds.

string

service

Host_in_use: the id of the service that holds the host.

string

503

Rejected; never contains credentials or upstream payloads.

object

error

required

object

code

required

Stable code, e.g. not_found, idempotency_conflict, session_working, usage_limit_exceeded. Open.

string

type

Category, e.g. invalid_request_error, authentication_error, usage_limit_error. Open.

string

message

string

host

Host_in_use: the host another service holds.

string

service

Host_in_use: the id of the service that holds the host.

string