Yapper API
Api reference
GET
/usage/storage

Stored bytes and asset counts by type, plus trashed items still held until they are purged. Matches the Storage card on the account usage page. Pass memberId for the assets one member created; another member's storage requires the key's member to be a team owner or admin. Returns usage_breakdown_unavailable (409) until the workspace's storage has been indexed.

Authorization

bearerAuth usage:read
AuthorizationBearer <token>

In: header

Scope: usage:read

Query Parameters

memberId?string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/usage/storage"
{  "memberId": "string",  "bytes": 0,  "assetCount": 0,  "trashBytes": 0,  "trashAssetCount": 0,  "byType": {    "image": {      "bytes": 0,      "assetCount": 0    },    "video": {      "bytes": 0,      "assetCount": 0    },    "audio": {      "bytes": 0,      "assetCount": 0    },    "file": {      "bytes": 0,      "assetCount": 0    },    "document": {      "bytes": 0,      "assetCount": 0    }  },  "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"  }}

Get a session's workspace GET

Returns the session's workspace: the folders, media, text documents, notes, pins and selected takes the session shows in the Yapper web app, and that the in-app Yapper agent works from. items lists every folder and file with its absolute path (such as /Characters/hero), sorted by path; top-level items have the root as parentId. unfiled lists the session's finished media that is in no folder. Pass path to list one folder and everything in it instead (unfiled is then empty). Hidden or cross-team sessions return not_found. Uses the processes:read scope.

Get usage state GET

Returns team credits plus member-limit state for the acting user bound to the API key. Credits are wallet-aware, like GET /credits: teams paying from a linked external wallet report its spendable balance in credit equivalents.