ASassemble

Create a live stream ticket

Mint a single-use WebSocket ticket for a live desktop view (VNC-compatible binary stream) or an interactive terminal (JSON text frames). Connect to the returned url with exactly the returned subprotocols before expiresAt. The credential travels only in the subprotocol. Streams end when the session pauses, stops, or is deleted.

post/v1/sessions/{id}/streams

Request

  • Base URL
    https://assemble-vms-api.fly.dev
  • URL
    https://assemble-vms-api.fly.dev/v1/sessions/{id}/streams
  • Auth
    HTTP bearer

Request body

type'desktop' | 'terminal' required
colsinteger

Terminal streams only. Defaults to 120.

rowsinteger

Terminal streams only. Defaults to 30.

Response

Single-use connection grant; the subprotocols contain a credential.

idstring required

Ticket ID; each ticket admits one connection.

type'desktop' | 'terminal' required
urlstring required

WebSocket endpoint to connect to.

subprotocolsstring[] required

Pass exactly these WebSocket subprotocols; the second carries the single-use credential.

expiresAtstring date-time required

Connect-by deadline for the ticket, not a stream duration.

Changes

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