Search text

POST

text

object

model_id

enum<string>

collection_ids

array

filters

object

case_sensitive

boolean

AND

array

NOR

array

group_by

object

field

string

field

string

    Field to group by
    
    Note: We currently do not support ad-hoc grouping.
    This means the field must be indexed separately. 
    Please contact us to add additional fields for grouping.

Add Example Value

max_features

integer

search_within_group

object

search_within_group

object

    Options for searching within grouped results. 
    When enabled, it performs a separate search for each group (e.g., file_id) and returns results organized by these groups. 
    This is useful for maintaining context within documents or files while still providing relevant search results across the entire collection.
    Note: Each group will contain its own pagination information.
    
    Note: This option may impact performance for large datasets, and it is not available for Free tier users.

enabled

boolean

inner_page_num

integer

inner_page_size

integer

sort

array

select

array

query

string

Headers

Authorization

string | null

index-id

string | null

filter by organization

Body

application/json

collection_ids

string[]

required

List of Collection IDs to search within, required

query

string

required

model_id

enum<string> | null

default: multimodal-v1

Embedding model to use

Available options:

vuse-generic-v1,

multimodal-v1,

image-embed-v1

filters

object | null

Complex nested query filters

group_by

object | null

Grouping options for search results

sort

object[] | null

List of fields to sort by, with direction (asc or desc)

select

string[] | null

List of fields to return in results, supports dot notation. If None, all fields are returned.

Response

200 - application/json

The response is of type object.

Was this page helpful?

API Documentation

Health

Multimodal Search

Multimodal Index

Features

Namespaces

Search Interactions

Entities

Assets

Accounts

Collections

Tasks

Headers

Body

Response