Skip to content
Scenario Docs
Get started
API Reference

Collections

List
collections.list(CollectionListParams**kwargs) -> SyncCollectionsCursor[CollectionListResponse]
GET/collections
Create
collections.create(CollectionCreateParams**kwargs) -> CollectionCreateResponse
POST/collections
Retrieve
collections.retrieve(strcollection_id) -> CollectionRetrieveResponse
GET/collections/{collectionId}
Update
collections.update(strcollection_id, CollectionUpdateParams**kwargs) -> CollectionUpdateResponse
PUT/collections/{collectionId}
Delete
collections.delete(strcollection_id) -> object
DELETE/collections/{collectionId}
ModelsExpand 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
class CollectionCreateResponse: …
collection: Collection
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[CollectionThumbnail]

The thumbnail for the collection (if any)

asset_id: str
url: str
class CollectionRetrieveResponse: …
collection: Collection
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[CollectionThumbnail]

The thumbnail for the collection (if any)

asset_id: str
url: str
class CollectionUpdateResponse: …
collection: Collection
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[CollectionThumbnail]

The thumbnail for the collection (if any)

asset_id: str
url: str

CollectionsAssets

Add
collections.assets.add(strcollection_id, AssetAddParams**kwargs) -> AssetAddResponse
PUT/collections/{collectionId}/assets
Remove
collections.assets.remove(strcollection_id, AssetRemoveParams**kwargs) -> AssetRemoveResponse
DELETE/collections/{collectionId}/assets
ModelsExpand Collapse
class AssetAddResponse: …
collection: Collection
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[CollectionThumbnail]

The thumbnail for the collection (if any)

asset_id: str
url: str
class AssetRemoveResponse: …
collection: Collection
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[CollectionThumbnail]

The thumbnail for the collection (if any)

asset_id: str
url: str

CollectionsModels

Add
collections.models.add(strcollection_id, ModelAddParams**kwargs) -> ModelAddResponse
PUT/collections/{collectionId}/models
Remove
collections.models.remove(strcollection_id, ModelRemoveParams**kwargs) -> ModelRemoveResponse
DELETE/collections/{collectionId}/models
ModelsExpand Collapse
class ModelAddResponse: …
collection: Collection
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[CollectionThumbnail]

The thumbnail for the collection (if any)

asset_id: str
url: str
class ModelRemoveResponse: …
collection: Collection
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[CollectionThumbnail]

The thumbnail for the collection (if any)

asset_id: str
url: str