Yapper API
Api reference
PATCH
/sessions/{sessionId}

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.

Authorization

bearerAuth processes:write
AuthorizationBearer <token>

In: header

Scope: processes:write

Path Parameters

sessionId*string

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" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "title": "string",  "imageUrl": "http://example.com",  "imageAssetId": "string",  "generations": {    "inProgress": 0,    "completed": 0  },  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "webUrl": "http://example.com",  "links": {    "self": "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"  }}

Update a canvas card PATCH

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.

Update a workspace item PATCH

Moves, renames, or annotates one item. Send only the fields to change; unknown or invalid fields are rejected before anything is written. Renaming a file renames its asset everywhere it is used, as in the web app. parentPath creates missing folders. A name already used in the destination folder returns conflict. The workspace root cannot be changed. The change shows up in the Yapper web app and is recorded with the API key or MCP client that made it; the in-app Yapper agent in that session is told about it on its next turn. Free. Uses the processes:write scope.