POST
TypeScript client

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

teamId
string
required

Team (workspace) id (UUID). Discover ids via the list teams endpoint or the agent context.

Body

application/json
query
string
required

Natural-language search query; may be empty only for explicitly filtered browse mode.

Maximum string length: 512
Example:

"green screen clip of someone pointing upward"

browse
boolean

Browse by asset types and categories without an embedding request; both filters are required.

cursor
string

a string at most 2048 character(s) long

Maximum string length: 2048
requiredTags
string[]

Exact tags that every browse result must contain, for example image_meme or category:animals. Available only with browse=true.

Required array length: 1 - 20 elements

a string at most 100 character(s) long

Required string length: 1 - 100
mode
enum<string>
default:metadata

Search strategy: metadata (keyword scoring), semantic (vector embeddings), or hybrid (both); defaults to metadata.

Available options:
metadata,
semantic,
hybrid
Example:

"hybrid"

limit
integer
default:10

Maximum number of results to return, 1 to 100; defaults to 10.

Required range: 1 <= x <= 100
Example:

10

includeSeedLibrary
boolean

Whether to also search the shared Octospark seed template library alongside team assets.

assetTypes
enum<string>[]

Restrict results to these asset types (image, video, audio, gif, document).

Available options:
image,
video,
audio,
gif,
document
Example:
assetCategories
enum<string>[]

Restrict results to these asset categories, e.g. user_upload, render, green_screen_template, music.

Available options:
user_upload,
render,
template,
green_screen_template,
sound_effect,
music,
brand_asset,
ai_image,
ai_video,
other
Example:

Response

Success

data
object[]
required
total
number
required
nextCursor
string | null
required
prevCursor
string | null
required
mode
enum<string>
required
Available options:
metadata,
semantic,
hybrid
costResult
object
required
embeddingStatus
object | null
required