Yapper API
Api reference
PATCH
/sessions/{sessionId}/canvas/nodes/{nodeId}

Changes one card. Send only the fields to change: label, position, size and lock on any card, plus the settings of its kind (the same fields as when adding it). Changing a generation card's model drops its customSettings and resets an aspect ratio or resolution the new model does not support to the model's default. selectedOutput picks which version wired cards downstream receive; null goes back to the newest. Returns the card with every version. Shows up live on the canvas in the Yapper web app. Free. Uses the processes:write scope.

Authorization

bearerAuth processes:write
AuthorizationBearer <token>

In: header

Scope: processes:write

Path Parameters

sessionId*string
nodeId*string

A card id from GET /sessions/{sessionId}/canvas.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Properties1 <= properties

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/sessions/string/canvas/nodes/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "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"}
{  "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"  }}

Favorite or restore an asset PATCH

Sets an asset's favorite flag, or restores it from the trash with trashed: false (trashed: true trashes it, like DELETE). Send only the fields to change; unknown fields are rejected. A trashed asset returns not_found unless the request sets trashed. Free.

Update a session PATCH

Renames a session and/or sets its image. imageAssetId must be a completed image or video asset in the team (a video shows its thumbnail); the chosen image stays until removeImage clears it, after which the image follows the newest generation again. Nothing is written if any field is invalid. Free.