Yapper API
Api reference
GET
/sessions/{sessionId}

Returns one session with its webUrl. List its contents with GET /processes?sessionId= or GET /assets?sessionId=. Hidden or cross-team sessions return not_found.

Authorization

bearerAuth processes:read
AuthorizationBearer <token>

In: header

Scope: processes:read

Path Parameters

sessionId*string

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/sessions/string"
{  "id": "string",  "title": "string",  "imageUrl": "http://example.com",  "imageAssetId": "string",  "generations": {    "inProgress": 0,    "completed": 0  },  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "webUrl": "http://example.com",  "links": {    "self": "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 prompting skill guidance GET

Returns one public prompt-writing guide. MCP clients normally use yapper_load_skill instead.

Get a session's canvas GET

Returns the session's node canvas: every card (node) with its settings, ports, latest versions and selected output, the wires (edges) between cards, and the LLM models a text-gen card can use. Every session has a canvas; exists is false until a card is added or the canvas is opened in the web app, and nodes is then empty. Lists the three newest versions per card; GET a node for all of them. Hidden or cross-team sessions return not_found. Uses the processes:read scope.