studios

Starts a Studio

Changed on Sep 28, 2026

Starts the given Studio session ID.

put/studios/{sessionId}/start

Request

The document declares no server URL.
Auth
HTTP bearer

Path parameters

sessionIdstring required

Studio session numeric identifier

Query parameters

workspaceIdinteger

Workspace numeric identifier

Request body

allowedUserIdsinteger[] nullable

customIconIdstring nullable

Avatar id (from POST /avatars) for the Studio session icon. Semantics on start: null = leave the existing icon unchanged (so a no-arg start from the connect/loading dialog doesn't touch it); empty string = clear the icon and delete the previous Avatar; non-empty = assign the referenced Avatar and delete the previous one.

descriptionstring nullable

labelIdsinteger[] nullable

namestring nullable

spotboolean nullable

Response

jobSubmittedboolean required