realtime

Create a realtime session

Mints a short-lived token for the workflow realtime Socket.IO endpoint. Connect with socket.io-client using path: socketPath and auth: {token: sessionToken}, then subscribe to topics (workflow-runs, run, activity, execution, contract). Returns 503 when the realtime transport is not enabled on the environment — fall back to the SSE stream endpoints.

post/v1/realtime/session

Request

  • Base URL
    https://api.b3os.org (the document declares no server; this is the origin it was published from)
  • URL
    https://api.b3os.org/v1/realtime/session
  • Auth
    none declared

Response

sessionToken + socketPath + expiresInSeconds

object required

Changes

No recorded changes to this operation across all 2 revisions of this API.