Yapper Docs
Api reference
GET
/sessions/{sessionId}/links

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:read
AuthorizationBearer <token>

In: header

Scope: processes:read

Path Parameters

sessionId*string

Query Parameters

view?string
Default"session"

Value in

  • "session"
  • "timeline"
  • "editor"
  • "canvas"
assetId?string

view=editor only: the image or video to open.

editorTab?string

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"
folderId?string

view=session only: the workspace folder to open (an item id from GET /sessions/{sessionId}/workspace).

folderPath?string

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"  }}