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.
Authorization
bearerAuth processes:writeIn: header
Scope: processes:write
Path Parameters
An item id from GET /sessions/{sessionId}/workspace.
Header Parameters
Optional key that makes the edit safe to retry: a retry with the same key and body replays instead of editing twice, and the same key with a different body returns idempotency_conflict. Scoped to the credential and session.
1 <= length <= 255Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
1 <= propertiesResponse Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://example.com/sessions/string/workspace/nodes/string" \ -H "Content-Type: application/json" \ -d '{}'{ "id": "string", "parentId": "string", "name": "string", "path": "/Characters/hero", "type": "folder", "kind": "folder", "assetId": "string", "previewUrl": "http://example.com", "note": "string", "pinned": true, "selected": true, "brief": true, "color": "string", "semantic": "string", "childCount": 0, "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" }}{ "error": { "code": "string", "message": "string", "requestId": "string" }}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.
Update a workspace item by path 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. Addresses the item by its path; /workspace/nodes/{nodeId} does the same by id. 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.