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.
Authorization
APIKeyHeader X-API-Key<token>
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://loading/api/v1/documents/query" \ -H "Content-Type: application/json" \ -d '{ "tenant_id": "string", "collection": "string" }'[
{
"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"
}
]{
"detail": "string",
"error": {
"code": "string",
"message": "string",
"details": {}
}
}{
"detail": "string",
"error": {
"code": "string",
"message": "string",
"details": {}
}
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string",
"input": null,
"ctx": {}
}
]
}