Skip to main content
POST
Query a container

Authorizations

Authorization
string
header
default:Bearer uk_live_your_api_key_here
required

Versuno API key. Must be prefixed with Bearer. Format: Bearer uk_live_...

Path Parameters

id
string<uuid>
required

ID of the brain.

containerId
string<uuid>
required

ID of the container to scope the query to.

Body

application/json
query
string
required

The natural-language query to search the container with.

Required string length: 1 - 4000
Example:

"What is the params prop?"

entities
string[]

Optional list of entity names to bias the search toward.

Example:
limit
integer
default:5

Maximum number of results to return (1–20, default 5).

Required range: 1 <= x <= 20
Example:

5

Response

Query result envelope. Check success to determine if the query actually succeeded.

Result envelope for a brain query. Always returned with HTTP 200; check success and error.

success
boolean

Whether the query succeeded. Inspect this rather than the HTTP status.

Example:

true

data
object | null

Query result payload, or null when success is false.

error
string | null

Error message when success is false, otherwise null.

Example:

null

metadata
object