Create a live stream ticket
POST
/v1/sessions/{id}/streamsMint 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.
Authorization
bearerAuth AuthorizationBearer <token>
Use the owner-scoped product API key provided by the service operator.
In: header
Path Parameters
id*string
Session ID returned by open or list.
Format
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
Request
curl -X POST "https://assemble-vms-api.fly.dev/v1/sessions/497f6eca-6276-4993-bfeb-53cbbbba6f08/streams" \ -H "Authorization: Bearer ${ASSEMBLE_API_KEY}" \ -H "Content-Type: application/json" \ -d '{ "type": "desktop" }'Response
{ "id": "string", "type": "desktop", "url": "string", "subprotocols": [ "string" ], "expiresAt": "2019-08-24T14:15:22Z"}