/search/assets

post

https://api.cloud.scenario.com/v1/search/assets

Search for assets. At least one of the following fields must have a value: query, filter, image, or images.

image, images are mutually exclusive.

Query Params

originalAssets

string

If set to true, returns the original asset without transformation

Body Params

filter

string

Defaults to undefined

Filter queries by an attribute's value

image

string

Search for similar images with image as a reference.

Must be an existing AssetId or a valid data URL.

imageSemanticRatio

number

0 to 1

Image embedding ratio for hybrid search, applied when image, images.like, or images.unlike are provided

images

object

Search for similar images with images.like and images.unlike as a reference

Must be arrays of existing AssetId or valid data URLs.

offset

number

≥ 0

Number of documents to skip. Must be used with limit. Starts from 0.

public

boolean

Defaults to false

Search for public images not necessarily belonging to the current ownerId

hitsPerPage

number

1 to 100

Maximum number of documents returned for a page. Must be used with page.

query

string

Defaults to ''

A string used for querying search results.

limit

number

1 to 100

Maximum number of documents returned. Must be used with offset.

sortBy

array of strings

Sort the search results by the given attributes. Each attribute in the list must be followed by a colon (:) and the preferred sorting order: either ascending (asc) or descending (desc).

Example: ['createdAt:desc']

sortBy

page

number

≥ 1

Request a specific page of results. Must be used with hitsPerPage.

querySemanticRatio

number

0 to 1

Query embedding for hybrid search, if possible

Response

Language

Credentials

Header

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200 response