API Endpoints

/search/models

post
https://api.cloud.scenario.com/v1/search/models

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

image, and images are mutually exclusive.

Query Params
string
Body Params
string
Defaults to undefined

Filter queries by an attribute's value

string

Search for model with image as a reference

Must be an existing AssetId or a valid data URL.

number
0 to 1

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

images
object

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

Must be an array of existing AssetId or valid data URLs.

number
≥ 0

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

boolean
Defaults to false

Search for public images not necessarily belonging to the current ownerId

number
1 to 100

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

string
Defaults to ''

A string used for querying search results.

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
number
≥ 1

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

number
0 to 1

Query embedding for hybrid search, if possible

Response

Updated 8 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 8 months ago