Yapper API
Api reference
DELETE
/sessions/{sessionId}/canvas/nodes

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.

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.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/sessions/string/canvas/nodes" \  -H "Content-Type: application/json" \  -d '{    "nodeIds": [      "string"    ]  }'
{  "removedNodeIds": [    "string"  ],  "notFoundNodeIds": [    "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 a canvas card DELETE

Removes one card and its wires. Shows up live on the canvas in the Yapper web app. Free. Uses the processes:write scope.

Remove assets from a session DELETE

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.