POST /api/v1/documents/query — filter documents by field equality on their JSONB data.

Exact-match filtering, not semantic search. Unlike Documents · Search this needs no embedding, so it reaches documents that were written without a data.summary.

Authorization

APIKeyHeader

X-API-Key<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

tenant_id?Tenant Id

Tenant to operate on. Omit it and the tenant is resolved from the credential, which is what a tenant- or agent-scoped key already identifies — no prior /whoami call is needed. Supply it to act on a different tenant your credential may read (and for an admin key, which belongs to no single tenant, it is required).

Default""

fleet_id?string|null

collection*Collection

Length1 <= length <= 200

where?

order_by?string|null

order?Order

Match^(asc|desc)$

Default"asc"

limit?Limit

Range1 <= value <= 1000

Default20

offset?Offset

Range0 <= value

Default0

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/documents/query" \  -H "Content-Type: application/json" \  -d '{    "collection": "string"  }'

[  {    "indexed": true,    "id": "string",    "tenant_id": "string",    "fleet_id": "string",    "collection": "string",    "doc_id": "string",    "data": {},    "created_at": "2019-08-24T14:15:22Z",    "updated_at": "2019-08-24T14:15:22Z",    "agent_id": "string"  }]

Documents · Query

AuthorizationCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

401application/json

403application/json

422application/json

Authorization

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`