Yapper API
Api reference
GET
/sessions/{sessionId}/canvas

Returns the session's node canvas: every card (node) with its settings, ports, latest versions and selected output, the wires (edges) between cards, and the LLM models a text-gen card can use. Every session has a canvas; exists is false until a card is added or the canvas is opened in the web app, and nodes is then empty. Lists the three newest versions per card; GET a node for all of them. Hidden or cross-team sessions return not_found. Uses the processes:read scope.

Authorization

bearerAuth processes:read
AuthorizationBearer <token>

In: header

Scope: processes:read

Path Parameters

sessionId*string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/sessions/string/canvas"
{  "sessionId": "string",  "exists": true,  "nodes": [    {      "id": "string",      "kind": "text",      "label": "string",      "position": {        "x": 0,        "y": 0      },      "width": 0,      "height": 0,      "locked": true,      "ports": {        "inputs": [          {            "id": "prompt",            "type": "text",            "maxConnections": 0,            "connected": 0          }        ],        "output": "text"      },      "inputs": [        {          "port": "string",          "sourceNodeId": "string",          "order": 0        }      ],      "text": "string",      "asset": {        "assetId": "string",        "type": "image",        "url": "string",        "thumbnailUrl": "string",        "width": 0,        "height": 0,        "duration": 0,        "name": "string"      },      "pending": true,      "prompt": "string",      "modelId": "string",      "aspectRatio": "string",      "resolution": "string",      "numOutputs": 0,      "duration": 0,      "durationMode": "string",      "generateAudio": true,      "customSettings": {},      "promptGuide": "string",      "runCount": 0,      "runs": [        {          "id": "string",          "index": 0,          "status": "waiting",          "processId": "string",          "canvasRunId": "string",          "modelId": "string",          "startedAt": "2019-08-24T14:15:22Z",          "creditsEstimated": 0,          "outputs": [            {              "assetId": "string",              "type": "image",              "url": "string",              "thumbnailUrl": "string",              "width": 0,              "height": 0,              "duration": 0,              "name": "string"            }          ],          "text": "string",          "error": "string"        }      ],      "selectedOutput": {        "runId": "string",        "outputIndex": 0      },      "output": null,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "edges": [    {      "id": "string",      "sourceNodeId": "string",      "targetNodeId": "string",      "targetPort": "prompt",      "type": "text",      "order": 0    }  ],  "textModels": [    {      "id": "string",      "name": "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 GET

Returns one session with its webUrl. List its contents with GET /processes?sessionId= or GET /assets?sessionId=. Hidden or cross-team sessions return not_found.

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.