Yapper API
Api reference
DELETE
/sessions/{sessionId}/assets

Takes media out of a session by asset id, whether it is filed in a workspace folder or unfiled, so it no longer appears there in the web app. Nothing is deleted: the assets stay in the team library. Media created in this session (Asset.sessionId) cannot leave it and is returned in keptAssetIds; ids that are not in the session are skipped. The in-app Yapper agent in that session is told about the change on its next turn. Free.

Authorization

bearerAuth processes:write
AuthorizationBearer <token>

In: header

Scope: processes:write

Path Parameters

sessionId*string

Header Parameters

Idempotency-Key?string

Optional key that makes the request safe to retry: a retry with the same key and body replays instead of running twice.

Length1 <= length <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/sessions/string/assets" \  -H "Content-Type: application/json" \  -d '{    "assetIds": [      "string"    ]  }'
{  "sessionId": "string",  "removedAssetIds": [    "string"  ],  "keptAssetIds": [    "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"  }}
{  "error": {    "code": "string",    "message": "string",    "requestId": "string"  }}

Remove canvas cards DELETE

Removes cards and every wire into or out of them. Assets the cards showed or made are not deleted and stay in the session. Ids that are not on the canvas come back in notFoundNodeIds. Shows up live on the canvas in the Yapper web app. Free. Uses the processes:write scope.

Remove a workspace item DELETE

Removes an item from the tree; a folder goes with everything in it. Never deletes assets, and does not always take media out of the session: media that was only filed here from elsewhere leaves it (unlinkedAssetIds), while media created in the session, or that joined it another way such as being used in a generation, stays in it unfiled (unfiledAssetIds). To take media out of the session itself, use DELETE /sessions/{sessionId}/assets. Removing the brief clears it. The workspace root cannot be removed. 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.