Yapper API
Api reference
POST
/sessions/{sessionId}/workspace/folders

Creates the folder at path along with any missing folders above it (like mkdir -p) and returns the last one. A folder already at path is returned unchanged. color and semantic apply to a newly created last folder. A file in the way of the path returns conflict. Unfoldered is reserved at the top level. The change shows up in the Yapper web app and is recorded with the API key or MCP client that made it; the in-app Yapper agent in that session is told about it on its next turn. Free. Uses the processes:write scope.

Authorization

bearerAuth processes:write
AuthorizationBearer <token>

In: header

Scope: processes:write

Path Parameters

sessionId*string

Header Parameters

Idempotency-Key?string

Optional key that makes the edit safe to retry: a retry with the same key and body replays instead of editing twice, and the same key with a different body returns idempotency_conflict. Scoped to the credential and session.

Length1 <= length <= 255

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/workspace/folders" \  -H "Content-Type: application/json" \  -d '{    "path": "/Characters/Heroes"  }'
{  "id": "string",  "parentId": "string",  "name": "string",  "path": "/Characters/hero",  "type": "folder",  "kind": "folder",  "assetId": "string",  "previewUrl": "http://example.com",  "note": "string",  "pinned": true,  "selected": true,  "brief": true,  "color": "string",  "semantic": "string",  "childCount": 0,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}
{  "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"  }}

Create a session POST

Creates a session to group related generations in the Yapper web app. Pass its id as sessionId on POST /processes, POST /assets/import, and POST /assets/uploads. Free. Uses the processes:write scope.

Unwire two canvas cards DELETE

Removes the wires from the source card into the target card, on every port or only targetPort. not_found when there is no such wire. Shows up live on the canvas in the Yapper web app. Free. Uses the processes:write scope.