API Endpoints
Complete reference of all API endpoints
Collections
Get collectionsGET
Retrieve a paginated list of all collections in the workspace.
Get collection by IDGET
Retrieve detailed information about a specific collection by its ID.
Get scenes in collectionGET
Retrieve all scenes that belong to a specific collection.
Create collectionPOST
Create a new collection in the workspace.
Create scene in collectionPOST
Create a new scene within a specific collection.
Update collectionPATCH
Update the metadata of an existing collection by its ID.
Delete collectionDELETE
Delete a collection by its ID.
Invites
Get workspace invitesGET
Retrieve a paginated list of invites for the current workspace.
Get workspace inviteGET
Retrieve details for a specific workspace invite by its ID.
Create invitePOST
Create a new invite for the workspace.
Update workspace invitePATCH
Update the metadata of a specific workspace invite by its ID.
Delete workspace inviteDELETE
Delete a specific workspace invite by its ID.
Logs
Scene Content
Get scene contentGET
Retrieve the complete content of a scene including all drawing elements and files.
Update scene contentPUT
Update the complete content of a scene with new elements, files, and settings.
Scenes
Get scenes in collectionGET
Retrieve all scenes that belong to a specific collection.
Get all scenesGET
Retrieve a paginated list of scenes with their metadata and associated links.
Get scene metadataGET
Retrieve detailed metadata for a specific scene by its ID.
Get scene contentGET
Retrieve the complete content of a scene including all drawing elements and files.
Create scene in collectionPOST
Create a new scene within a specific collection.
Create new scenePOST
Create a new empty scene with specified metadata in a collection.
Update scene metadataPATCH
Update specific metadata fields of an existing scene.
Update scene contentPUT
Update the complete content of a scene with new elements, files, and settings.
Delete scene by IDDELETE
Permanently delete a scene and all its associated data.
Users
Get workspace usersGET
Retrieve a paginated list of users in the current workspace.
Get workspace userGET
Retrieve details for a specific user in the current workspace by user ID.
Update workspace userPATCH
Update the metadata of a specific user in the current workspace by user ID.
Delete workspace userDELETE
Remove a specific user from the current workspace by user ID.
Workspace
Get workspace dataGET
Retrieve the current workspace's metadata, including users and invites.
Get workspace usersGET
Retrieve a paginated list of users in the current workspace.
Get workspace userGET
Retrieve details for a specific user in the current workspace by user ID.
Get workspace invitesGET
Retrieve a paginated list of invites for the current workspace.
Get workspace inviteGET
Retrieve details for a specific workspace invite by its ID.
Create invitePOST
Create a new invite for the workspace.
Update workspace dataPATCH
Update the current workspace's metadata.
Update workspace userPATCH
Update the metadata of a specific user in the current workspace by user ID.
Update workspace invitePATCH
Update the metadata of a specific workspace invite by its ID.
Delete workspace userDELETE
Remove a specific user from the current workspace by user ID.
Delete workspace inviteDELETE
Delete a specific workspace invite by its ID.
