knowledge module route (requires knowledge:retrieval:read)

POST

/v1/m/knowledge/kbs/{id}/query

curl --request POST \
  --url https://example.com/v1/m/knowledge/kbs/example/query \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "agent_ref": "example", "query": "example", "session_ref": "example", "top_k": 1 }'

• this engine

Runs one retrieval query against a knowledge base and returns the ranked passages.

Authorizations

• bearerAuth

Parameters

Path Parameters

id

required

string

Path parameter id.

Header Parameters

X-Olivares-Tenant

string format: uuid

Target tenant id; required when the principal can act in more than one tenant.

Request Body ^required

Media type application/json

object

agent_ref

Accepted for compatibility but ignored for authorization.

string

query

required

string

>= 1 characters <= 8192 characters /\S/

session_ref

string

top_k

Values at or below zero default to 10; values above 100 are clamped to 100.

integer

Example ^generated

{
  "agent_ref": "example",
  "query": "example",
  "session_ref": "example",
  "top_k": 1
}

Responses

200

OK

Media type application/json

object

Example ^generated

{}

400

Bad request

Media type application/json

object

Example ^generated

{}

401

Unauthenticated

Media type application/json

object

Example ^generated

{}

403

Forbidden

Media type application/json

object

Example ^generated

{}

404

Not found

Media type application/json

object

Example ^generated

{}

409

Conflict / setup required

Media type application/json

object

Example ^generated

{}

429

Rate limited

Media type application/json

object

Example ^generated

{}