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.
Authorization
bearerAuth processes:readIn: header
Scope: processes:read
Path Parameters
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/sessions/string/timeline"{ "sessionId": "string", "exists": true, "name": "string", "duration": 0, "clips": [ { "clipId": "string", "kind": "video", "assetId": "string", "track": 1, "startTime": 0, "endTime": 0, "trimStart": 0, "trimEnd": 0, "volume": 0 } ], "transitions": [ {} ], "textClips": [ {} ], "mutedTracks": [ 0 ], "gaps": [ {} ], "revision": 0, "updatedAt": "2019-08-24T14:15:22Z", "webUrl": "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 web app link GET
A link that opens the session in the Yapper web app, optionally on one tool, fullscreen. With view=editor, assetId opens that image or video (adding it to the strip) and editorTab opens a panel. With view=session, folderId or folderPath opens it on that workspace folder, selected. For a timeline, timelineExists false means the session has none yet. Uses the processes:read scope.
Get a session's workspace GET
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.