Skip to content

Search Visual Assets

POST
/api/creative/visual-studio/assets/search

Search assets semantically by description and tags, scoped to owner projects.

SearchAssetsRequest

Request model for semantic asset search.

object
query
required
Query

Search query

string
limit
Limit

Max results

integer
default: 20 >= 1 <= 100

Successful Response

VisualSearchResponse

Response model for asset semantic search.

object
assets
Assets

Matching assets

Array<object>
VisualAsset

Visual asset model for API responses.

Represents a complete visual asset with all metadata, tags, and project association information.

Attributes: id: Unique asset identifier project_id: Parent project identifier type: Asset type (image, video, audio, etc.) name: Human-readable asset name url: Asset URL or file path metadata: Detailed asset metadata created_at: Unix timestamp of creation updated_at: Unix timestamp of last update tags: List of categorization tags

object
id
required
Id

Asset ID

string
projectId
required
Projectid

Project ID

string
type
required
Type

Asset type

string
name
required
Name

Asset name

string
url
required
Url

Asset URL

string
metadata
VisualAssetMetadata

Visual asset metadata model.

Contains detailed metadata about visual assets including file size, format, dimensions, duration, and custom fields.

Attributes: file_size: File size in bytes (optional) format: File format (PNG, JPG, MP4, etc.) dimensions: Asset dimensions (e.g., 1920x1080) duration: Duration in seconds for video/audio custom: Custom metadata key-value pairs

object
fileSize
Any of:
integer
format
Any of:
string
dimensions
Any of:
string
duration
Any of:
number
custom
Custom

Custom metadata fields

object
key
additional properties
Any of:
string
createdAt
required
Createdat

Creation timestamp

integer
updatedAt
required
Updatedat

Last update timestamp

integer
tags
Tags

Asset tags

Array<string>
description
Description

Asset description

string
""
folderId
Any of:
string
annotations
Annotations

Image annotations

Array<object>
VisualAnnotation

A spatial annotation on a visual asset.

object
id
required
Id

Annotation ID

string
text
required
Text

Annotation text

string
x
required
X

Normalized X position (0-1)

number
<= 1
y
required
Y

Normalized Y position (0-1)

number
<= 1
createdAt
required
Createdat

Creation timestamp

integer
total
Total

Total results count

integer
0
query
Query

Original search query

string
""

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object