Yapper Docs
Api reference
GET
/assets

Lists normalized team assets, newest first (order=oldest reverses it). Filters combine: every parameter applies, and a comma-separated value matches any of its values (model=a,b). createdAfter/createdBefore bound the creation time, and metadata.= (up to 3) matches the metadata copied from the process that made the asset, e.g. metadata.order=A-17 for every output of that order. A team whose library has not moved to the new storage yet answers one type, at most one value of processType, source, model, tool, genType, or sessionId, and favorite; anything else returns unsupported_filter_combination for it (and a missing type returns invalid_request).

Authorization

bearerAuth assets:read
AuthorizationBearer <token>

In: header

Scope: assets:read

Query Parameters

type?string

image, video, or audio; comma-separated for several. Omit for all three.

favorite?boolean

Only favorited assets.

sessionId?string

Only items in this session.

folderId?string
Deprecated

Deprecated alias of sessionId.

libraryFolderId?string

Library folder ids (GET /library/folders), comma-separated; an asset in any of them matches. Workspaces not yet moved to the new library take one id and no other filter but favorite.

source?string

Comma-separated, any of: upload, provided, image-gen-process, video-generation-process, timeline-export.

processType?string

Process types that made the asset, comma-separated (see POST /processes).

model?string

Model ids, comma-separated (see GET /models).

tool?string

Tools, comma-separated.

genType?string

Comma-separated, any of: video-sync, image-to-video, image-to-video-sync, text-to-video.

createdBy?string

Member user ids, comma-separated; me is the key's member (see GET /members).

createdAfter?string
Formatdate-time
createdBefore?string
Formatdate-time
origin?string

Value in

  • "uploaded"
  • "generated"
downloaded?boolean

Only assets someone downloaded.

unseen?boolean

Only assets not viewed yet.

search?string

Words matched against asset titles and names (as prefixes) and their full text.

Lengthlength <= 200
order?string

By creation time. Pass the same order with cursor as the request that returned it.

Default"newest"

Value in

  • "newest"
  • "oldest"
limit?integer
Range1 <= value <= 100
Default20
cursor?string

Opaque pagination cursor — pass the nextCursor from the previous page verbatim. nextCursor is null on the last page.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/assets"
{  "data": [    {      "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",      "prompt": "string",      "model": "string",      "trainingId": "string",      "draft": {        "finishableUntil": "2019-08-24T14:15:22Z",        "finishResolutions": [          1080        ]      },      "favorite": true,      "sessionId": "string",      "libraryFolderIds": [        "string"      ],      "createdBy": "string",      "metadata": {        "property1": "string",        "property2": "string"      },      "testMode": true,      "webUrl": "http://example.com",      "createdAt": "2019-08-24T14:15:22Z",      "links": {        "self": "string"      }    }  ],  "nextCursor": "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"  }}