Sign in

v5

latestOpenAPI 3.1.02026-08-025631,1012.8 MB
Documents

Run multiple list-documents queries concurrently.

Execute up to 10 POST /v1/documents/list queries in parallel against the same namespace and return their responses together.

Collapses dossier / multi-collection N+1 fan-outs into one round-trip. Each sub-query is independent; a failure in one does not fail the batch — the failing entry's response is null and error carries a short message.

post/v1/documents/list/batch

Request body

Example request

{
  "queries": [
    {
      "request": {
        "filters": {
          "AND": [
            {
              "field": "name",
              "operator": "eq",
              "value": "John"
            },
            {
              "field": "age",
              "operator": "gte",
              "value": 30
            }
          ],
          "OR": [
            {
              "field": "status",
              "operator": "eq",
              "value": "active"
            },
            {
              "field": "role",
              "operator": "eq",
              "value": "admin"
            }
          ],
          "NOT": [
            {
              "field": "department",
              "operator": "eq",
              "value": "HR"
            },
            {
              "field": "location",
              "operator": "eq",
              "value": "remote"
            }
          ],
          "case_sensitive": true
        },
        "sort": {
          "field": "created_at"
        },
        "group_by": "source_object_id",
        "select": [
          "metadata.title",
          "content"
        ],
        "expand": [
          "customer_id"
        ]
      }
    }
  ]
}

Response

Successful Response

Example response

{
  "results": [
    {
      "response": {
        "description": "Regular document list (no grouping)",
        "pagination": {
          "has_more": false,
          "limit": 10,
          "offset": 0,
          "total_count": 1
        },
        "results": [
          {
            "collection_id": "col_articles",
            "document_id": "doc_123",
            "metadata": {
              "title": "AI Article"
            }
          }
        ],
        "stats": {
          "avg_blobs_per_document": 1,
          "total_documents": 1
        }
      }
    }
  ]
}