Yapper API
Api reference
POST
/sessions/{sessionId}/canvas/runs/{runId}/cancel

Takes cards that have not started out of a running canvas run: nodeIds plus the run's cards behind them, or every waiting card when nodeIds is omitted. A card whose generation has started cannot be cancelled, and nothing is charged for a card that never starts. conflict when nothing could be cancelled. Uses the processes:write scope.

Authorization

bearerAuth processes:write
AuthorizationBearer <token>

In: header

Scope: processes:write

Path Parameters

sessionId*string
runId*string

A canvas run id from POST /sessions/{sessionId}/canvas/runs.

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 POST "https://example.com/sessions/string/canvas/runs/string/cancel" \  -H "Content-Type: application/json" \  -d '{}'
{  "runId": "string",  "cancelledNodeIds": [    "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"  }}