POST

https://{capsule-id}.sid.ai

/
query

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <API_KEY>. API keys can be generated in the dashboard.

Body

application/json
query
string
required

The search query string

limit
integer

Maximum number of results to return

wishlist
object

Additional filtering criteria for the query

Response

200 - application/json
item_id
string

Unique identifier for the item

idx
integer

Index of the chunk within the item

content
string

Content of the chunk

uri
string

URI associated with the item

kind
string

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

file_name
string

Name of the file (for file items)

file_type
string

MIME type of the file (for file items)

time_added
string

Timestamp when the item was added to the capsule

time_authored
string

Timestamp when the item was originally authored

score
number

Relevance score of the result

metadata
object

Additional metadata associated with the item

Was this page helpful?

Chat with a capsule