Skip to content
FLORA FLORA API

List assets

GET
/assets
 
import { FloraClient } from '@flora-ai/flora';


const client = new FloraClient({ apiKey: process.env['FLORA_API_KEY'] });


// Paginated lists are async iterables; further pages are fetched as needed.
for await (const asset of await client.assets.list()) {
  console.log(asset);
}

Returns assets visible to the authenticated public API key. Filter by workspace, project canvas, search query, cursor, and limit without exposing raw file bytes or internal graph data.

Error responses use the standard error body.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
limit

Maximum number of results to return

integer
>= 1 <= 100

Maximum number of results to return

cursor

Opaque cursor for fetching the next page

string

Opaque cursor for fetching the next page

query

Search query

string

Search query

workspace_id

Workspace identifier

string
/^ws_\S+$/

Workspace identifier

project_id

Project identifier

string
/^prj_\S+$/

Project identifier

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Assets returned.

Media type application/json
object
assets
required
Array<object>
object
asset_id
required
Any of:

Asset identifier

string
/^asset_\S+$/
name
required
Any of:
string
description
required
Any of:
string
workspace_id
required
Any of:

Workspace identifier

string
/^ws_\S+$/
url
required
Any of:
string
content_type
required

Asset content type

string
upload_content_type
required
Any of:
string
uploaded_via
required

Asset source

string
status
required
string
Allowed values: pending_upload ready failed
width
required
Any of:
integer
height
required
Any of:
integer
size_bytes
required
Any of:
integer
created_at
required
Any of:
integer
node_id
Any of:

Associated node identifier

string
project_id
Any of:

Project identifier

string
/^prj_\S+$/
meta
required
object
next_cursor
required
Any of:

Opaque cursor for fetching the next page

string
total_estimate
Any of:

Estimated total matching items

integer
Example 
{
  "assets": [
    {
      "asset_id": "asset_abc123",
      "workspace_id": "ws_abc123",
      "status": "pending_upload",
      "node_id": "node_abc123",
      "project_id": "prj_abc123"
    }
  ],
  "meta": {
    "next_cursor": "eyJvZmZzZXQiOjIwfQ"
  }
}