v3

latestOpenAPI 3.0.0raw.githubusercontent.com2024-10-29748.2 KB
Query

Query capsule

post/query

Request body

querystring required

The search query string

limitinteger

Maximum number of results to return

wishlistobject

Additional filtering criteria for the query

Response

Successful response

item_idstring

Unique identifier for the item

idxinteger

Index of the chunk within the item

contentstring

Content of the chunk

uristring

URI associated with the item

kindstring

Type of the item (e.g., 'file' or 'text')

file_namestring

Name of the file (for file items)

file_typestring

MIME type of the file (for file items)

time_addedstring date-time

Timestamp when the item was added to the capsule

time_authoredstring date-time

Timestamp when the item was originally authored

scorenumber float

Relevance score of the result

metadataobject

Additional metadata associated with the item