API Reference
Documents · Query
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.
POST
APIKeyHeaderheader
X-API-Key<token>application/json- body
tenant_id?Tenant IdTenant 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|nullcollection*CollectionLength
1 <= length <= 200where?order_by?string|nullorder?OrderMatch
^(asc|desc)$Default
"asc"limit?LimitRange
1 <= value <= 1000Default
20offset?OffsetRange
0 <= valueDefault
0Successful Response
application/json- response
[index: integer]?curl -X POST 'https://example.com/api/v1/documents/query' \ -H 'Content-Type: application/json' \ -d '{ "collection": "string"}'Example Response
[ { "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" }]