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

Returns a canvas run's status and, per card in run order, its state, why it failed, the process ids it started, and the outputs (or text, for LLM cards) this run made. While status is running, wait suggestedPollAfterSeconds between polls. Uses the processes:read scope.

Authorization

bearerAuth processes:read
AuthorizationBearer <token>

In: header

Scope: processes:read

Path Parameters

sessionId*string
runId*string

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

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/sessions/string/canvas/runs/string"
{  "id": "string",  "status": "running",  "scope": "selection",  "startNodeIds": [    "string"  ],  "creditsEstimated": 0,  "createdAt": "2019-08-24T14:15:22Z",  "finishedAt": "2019-08-24T14:15:22Z",  "endedReason": "string",  "suggestedPollAfterSeconds": 0,  "nodes": [    {      "nodeId": "string",      "step": 0,      "kind": "string",      "label": "string",      "state": "pending",      "reason": "needsPrompt",      "detail": "string",      "processIds": [        "string"      ],      "outputs": [        {          "assetId": "string",          "type": "image",          "url": "string",          "thumbnailUrl": "string",          "width": 0,          "height": 0,          "duration": 0,          "name": "string"        }      ],      "texts": [        "string"      ],      "errors": [        "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"  }}

Get a canvas card GET

Returns one card with every version (run) it has made, newest first. Uses the processes:read scope.

Get connection identity GET

Returns the team, the acting user with their name and team role, the credential kind/name, and granted scopes for the current API key or MCP OAuth connection. Use this before moving assets between multiple configured Yapper connections.