Yapper API
Api reference
GET
/sessions/{sessionId}/workspace/nodes/{nodeId}

Reads one workspace item. A folder returns its direct children; a text document returns its text a page at a time (pass nextOffset as offset for the rest); another uploaded file returns its name, type, size and download URL; an image, video or audio item returns its asset, shaped like GET /assets/{assetId}. Only item is returned when the backing record is gone. Uses the processes:read scope.

Authorization

bearerAuth processes:read
AuthorizationBearer <token>

In: header

Scope: processes:read

Path Parameters

sessionId*string
nodeId*string

An item id from GET /sessions/{sessionId}/workspace.

Query Parameters

offset?integer

Text documents only: the character to start at (nextOffset from the previous read).

Range0 <= value
Default0
limit?integer

Text documents only: characters to return.

Range1 <= value <= 100000
Default20000

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/sessions/string/workspace/nodes/string"
{  "item": {    "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"  },  "children": [    {      "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"    }  ],  "document": {    "format": "markdown",    "content": "string",    "offset": 0,    "totalCharacters": 0,    "nextOffset": 0  },  "file": {    "name": "string",    "mimeType": "string",    "byteSize": 0,    "url": "http://example.com"  },  "asset": {    "id": "string",    "type": "image",    "name": "string",    "url": "http://example.com",    "thumbnailUrl": "http://example.com",    "preview": {      "url": "http://example.com",      "width": 0,      "height": 0,      "mimeType": "string"    },    "width": 0,    "height": 0,    "duration": 0,    "mimeType": "string",    "source": "string",    "sourceProcessId": "string",    "trainingId": "string",    "draft": {      "finishableUntil": "2019-08-24T14:15:22Z"    },    "favorite": true,    "sessionId": "string",    "createdAt": "2019-08-24T14:15:22Z",    "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"  }}
{  "error": {    "code": "string",    "message": "string",    "requestId": "string"  }}

Get billing cycle credits GET

This billing cycle's credits and the next plan refill. Matches the Workspace Credits card on the account usage page. The period is the plan's monthly renewal window (yearly plans are divided into monthly windows), or the UTC calendar month for a workspace without an active plan. credits.available is the workspace's Yapper credit balance; GET /usage reports a linked external wallet.

Read a workspace item by path GET

Reads one workspace item. A folder returns its direct children; a text document returns its text a page at a time (pass nextOffset as offset for the rest); another uploaded file returns its name, type, size and download URL; an image, video or audio item returns its asset, shaped like GET /assets/{assetId}. Only item is returned when the backing record is gone. Addresses the item by its path; /workspace/nodes/{nodeId} does the same by id. Uses the processes:read scope.