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:writeIn: header
Scope: processes:write
Path Parameters
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" }}Add assets to a session POST
Adds existing team assets to a session so they appear in it in the web app. Membership only: where an asset was created (Asset.sessionId) does not change. Already-member, deleted, and unknown ids are skipped. Free.
Cancel a process POST
Cancels a process started through the API while it hasn't been sent to the provider, usually its first few seconds, and refunds it in full. It then reads as failed with error.code cancelled, and process.failed goes to webhooks. Once the provider has accepted it, the call answers 409 conflict and the process runs to the end (a failure is refunded automatically). Canvas runs and wallet-funded runs can't be cancelled.