Returns the session's workspace: the folders, media, text documents, notes, pins and selected takes the session shows in the Yapper web app, and that the in-app Yapper agent works from. items lists every folder and file with its absolute path (such as /Characters/hero), sorted by path; top-level items have the root as parentId. unfiled lists the session's finished media that is in no folder. Pass path to list one folder and everything in it instead (unfiled is then empty). Hidden or cross-team sessions return not_found. Uses the processes:read scope.
Authorization
bearerAuth processes:readIn: header
Scope: processes:read
Path Parameters
Query Parameters
Only this folder and everything in it, such as /Characters. Names match exactly first, then ignoring case.
1 <= length <= 4000Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/sessions/string/workspace?path=%2FCharacters%2Fhero"{ "sessionId": "string", "rootId": "string", "briefNodeId": "string", "items": [ { "id": "string", "parentId": "string", "name": "string", "path": "/Characters/hero", "type": "folder", "kind": "folder", "assetId": "string", "previewUrl": "http://example.com", "note": "string", "pinned": true, "selected": true, "brief": true, "color": "string", "semantic": "string", "childCount": 0, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } ], "unfiled": [ { "assetId": "string", "name": "string", "type": "image", "previewUrl": "http://example.com" } ]}{ "error": { "code": "string", "message": "string", "requestId": "string" }}{ "error": { "code": "string", "message": "string", "requestId": "string" }}{ "error": { "code": "string", "message": "string", "requestId": "string" }}{ "error": { "code": "string", "message": "string", "requestId": "string" }}{ "error": { "code": "string", "message": "string", "requestId": "string" }}Get a session's timeline GET
Returns the session's video timeline: clips (clipId, kind, assetId, 1-based track, start and end on the timeline, trim in source seconds, volume, framing, look and keyframes), transitions, text and caption clips, gaps and the total duration. exists is false until the session has a timeline; POST .../timeline/edits makes one. webUrl opens it fullscreen in the web app. Uses the processes:read scope.
Get storage usage GET
Stored bytes and asset counts by type, plus trashed items still held until they are purged. Matches the Storage card on the account usage page. Pass memberId for the assets one member created; another member's storage requires the key's member to be a team owner or admin. Returns usage_breakdown_unavailable (409) until the workspace's storage has been indexed.