API Reference

Collections

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

List

collections.list(CollectionListParams**kwargs) -> SyncCollectionsCursor[CollectionListResponse]

GET/collections

List collections of a team

ParametersExpand Collapse

page_size: Optional[int]

The number of items to return in the response. The default value is 10, maximum value is 100, minimum value is 1

minimum1

maximum100

pagination_token: Optional[str]

A token you received in a previous request to query the next page of items

ReturnsExpand Collapse

class CollectionListResponse: …

id: str

The collection ID (example: “asset_GTrL3mq4SXWyMxkOHRxlpw”)

asset_count: float

created_at: str

The collection creation date as an ISO string (example: “2023-02-03T11:19:41.579Z”)

item_count: float

model_count: float

name: str

The collection name

owner_id: str

The owner ID (example: “dcf121faaa1a0a0bbbd9ca1b73d62aea”)

updated_at: str

The collection last update date as an ISO string (example: “2023-02-03T11:19:41.579Z”)

thumbnail: Optional[Thumbnail]

The thumbnail for the collection (if any)

asset_id: str

url: str

List

Python

HTTP

TypeScript

Python

import os
from scenario_sdk import Scenario

client = Scenario(
    api_key=os.environ.get("SCENARIO_SDK_API_KEY"),  # This is the default and can be omitted
    api_secret=os.environ.get("SCENARIO_SDK_API_SECRET"),  # This is the default and can be omitted
)
page = client.collections.list()
page = page.collections[0]
print(page.id)

200 example

{
  "collections": [
    {
      "id": "id",
      "assetCount": 0,
      "createdAt": "createdAt",
      "itemCount": 0,
      "modelCount": 0,
      "name": "name",
      "ownerId": "ownerId",
      "updatedAt": "updatedAt",
      "thumbnail": {
        "assetId": "assetId",
        "url": "url"
      }
    }
  ],
  "nextPaginationToken": "nextPaginationToken"
}

Returns Examples

200 example

{
  "collections": [
    {
      "id": "id",
      "assetCount": 0,
      "createdAt": "createdAt",
      "itemCount": 0,
      "modelCount": 0,
      "name": "name",
      "ownerId": "ownerId",
      "updatedAt": "updatedAt",
      "thumbnail": {
        "assetId": "assetId",
        "url": "url"
      }
    }
  ],
  "nextPaginationToken": "nextPaginationToken"
}