API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Search

Asset Search

client.search.assetSearch(SearchAssetSearchParams { originalAssets, filter, hitsPerPage, 10 more } params, RequestOptionsoptions?): SearchHitsOffset<SearchAssetSearchResponse { id, authorId, collectionIds, 14 more } >

POST/search/assets

Model Search

client.search.modelSearch(SearchModelSearchParams { originalAssets, originalModels, filter, 11 more } params, RequestOptionsoptions?): SearchHitsOffset<SearchModelSearchResponse { id, authorId, capabilities, 17 more } >

POST/search/models

ModelsExpand Collapse

SearchAssetSearchResponse { id, authorId, collectionIds, 14 more }

id: string

Unique identifier for the asset (e.g., “asset_GTrL3mq4SXWyMxkOHRxlpw”)

authorId: string

User ID of the asset creator/author

collectionIds: Array<string>

Array of collection IDs this asset belongs to

createdAt: string

Creation timestamp in ISO 8601 format (e.g., “2025-01-16T11:19:41.579Z”)

metadata: Metadata { aspectRatio, baseModelId, guidance, 17 more }

Metadata containing detailed information about the asset’s properties and generation parameters

aspectRatio?: string

Aspect ratio of the asset (e.g., “1:1”, “16:9”)

baseModelId?: string

ID of the base model used for generation

guidance?: number

Guidance scale used for diffusion models to control prompt adherence

height?: number

Height of the asset in pixels

kind?: string

Classification of the asset (e.g., “image”, “video”)

modelId?: string

ID of the specific model used if asset is model-based

modelType?: string

Type of model used for generation (e.g., “sd-1_5”, “flux.1”)

name?: string

Custom name given to the asset

negativePrompt?: string

Negative prompt used during generation to specify what to avoid

negativePromptStrength?: number

For Flux models: controls the influence of the negative prompt

numInferenceSteps?: number

Number of inference steps used during generation

parentJobId?: string

ID of the parent job that created this asset

prompt?: string

Text prompt used to generate the asset

scheduler?: string

Scheduler algorithm used during generation

seed?: string

Random seed used for generation, enables reproducibility

size?: number

File size of the asset in bytes

text?: string

Text used to generate the asset: mainly for speech to text

thumbnail?: Thumbnail { assetId }

Thumbnail image information for the asset. Ex. Canvas thumbnail

assetId: string

ID of the asset used as thumbnail

type?: string

Specific type/category of the asset (e.g., “canvas”, “inference-txt”)

width?: number

Width of the asset in pixels

mimeType: string

MIME type of the asset (e.g., “image/png”, “image/jpeg”)

nsfw: Array<string>

Array of detected NSFW categories

ownerId: string

Project ID of the asset owner

privacy: string

Privacy setting of the asset (“public”, “private”, or “unlisted”)

tags: Array<string>

Array of user-assigned tags for categorization

teamId: string

Team ID of the asset owner

updatedAt: string

Last modification timestamp in ISO 8601 format (e.g., “2025-01-16T11:19:41.579Z”)

url: string

Signed URL of the asset

description?: string

Textual description of the asset. Can be either:

• User-provided description for training images
• Automatically generated caption for images and videos assets
• Automatically generated description for audio assets

score?: number

Score assigned to the asset based on usage and popularity

thumbnail?: Thumbnail { assetId, url }

Thumbnail preview of the asset 3D, video…

assetId: string

ID of the asset used as thumbnail

url: string

Signed URL of the thumbnail

transcription?: string

Transcription of the asset. Can be either:

• Automatically generated transcription for audio assets with speech

SearchModelSearchResponse { id, authorId, capabilities, 17 more }

id: string

Unique identifier for the model (e.g., “model_GTrL3mq4SXWyMxkOHRxlpw”)

authorId: string

User ID of the model creator/author

capabilities: Array<string>

Array of model capabilities

collectionIds: Array<string>

Array of collection IDs this model belongs to

concepts: Array<Concept>

Array of concept models associated with this model Each concept contains a reference to its source model

modelId: string

ID of the concept’s source model

createdAt: string

Creation timestamp in ISO 8601 format (e.g., “2025-01-16T11:19:41.579Z”)

exampleAssetIds: Array<string>

Array of example asset IDs associated with this model

name: string

Display name of the model

ownerId: string

Project ID of the model owner

privacy: string

Privacy setting of the model (“public”, “private”, or “unlisted”)

shortDescription: string

Short description of the model

source: string

Source/origin of the model (e.g., “training”, “import”)

tags: Array<string>

Array of user-assigned tags for categorization

teamId: string

Team ID of the model owner

trainingImagesNumber: number

Number of images used to train this model

type: string

Type of the model (e.g., “sd-1_5”, “flux.1”)

updatedAt: string

Last modification timestamp in ISO 8601 format (e.g., “2025-01-16T11:19:41.579Z”)

parentModelId?: string

ID of the parent model this model was derived from

score?: number

Score assigned to the model based on usage and popularity

thumbnail?: Thumbnail { assetId, url }

Thumbnail image information for the model

assetId: string

ID of the asset used as thumbnail

url: string

Signed URL of the thumbnail