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.
Authorization
bearerAuth processes:readIn: header
Scope: processes:read
Path Parameters
Query Parameters
"session"Value in
- "session"
- "timeline"
- "editor"
- "canvas"
view=editor only: the image or video to open.
view=editor only: the panel to open.
Value in
- "details"
- "ai-edit"
- "change-region"
- "crop-inpaint"
- "adjustments"
- "texture-effects"
- "camera-angle-adjust"
- "upscale"
- "background-removal"
- "trim"
- "frames"
view=session only: the workspace folder to open (an item id from GET /sessions/{sessionId}/workspace).
view=session only: the workspace folder to open by absolute path, such as /Characters/hero (instead of folderId).
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/sessions/string/links"{ "sessionId": "string", "view": "session", "url": "http://example.com", "assetId": "string", "editorTab": "string", "timelineExists": true, "folder": { "id": "string", "path": "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" }}{ "error": { "code": "string", "message": "string", "requestId": "string" }}Get a session's Editor GET
Returns the assets in the session's Editor strip, oldest first (the newest 200), each with webUrl opening the editor on it, plus the editor's running edits as processes. Uses the processes:read scope.
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.