POST
/
query
Query capsule
curl --request POST \
  --url https://{capsule-id}.sid.ai/query \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "query": "<string>",
  "limit": 123,
  "wishlist": {}
}'
[
  {
    "item_id": "<string>",
    "idx": 123,
    "content": "<string>",
    "uri": "<string>",
    "kind": "<string>",
    "file_name": "<string>",
    "file_type": "<string>",
    "time_added": "2023-11-07T05:31:56Z",
    "time_authored": "2023-11-07T05:31:56Z",
    "score": 123,
    "metadata": {}
  }
]

Authorizations

​
Authorization
string
header
required

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

Successful response

​
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<date-time>

Timestamp when the item was added to the capsule

​
time_authored
string<date-time>

Timestamp when the item was originally authored

​
score
number

Relevance score of the result

​
metadata
object

Additional metadata associated with the item