Account1

Adhoc Retrievers3

Agent Sessions11

Alerts16

Analytics42

Annotations9

Apps34

Batches4

Bucket Batches23

Bucket Objects10

Bucket Syncs15

Bucket Uploads7

Buckets7

BYO Documents5

Cluster Executions7

Cluster Triggers8

Clusters10

Collection Documents19

Collection Lifecycle2

Collection Schema1

Collection Taxonomies1

Collections14

Custom Models8

Data Subject Access Requests3

Discovery4

Document Lineage3

Documents6

Events1

Extractor Publishing5

Extractors5

Feature Extractors2

Feature Search1

Features1

Health4

Inference1

Manifest7

Marketplace14

Models6

Namespace Clone1

Namespace Extractors2

Namespace Migrations7

Namespace Snapshots6

Namespaces10

Notifications13

Onboarding2

Ops1

Organization API Keys5

Organization Audit5

Organization Billing22

Organization Connections8

Organization Infrastructure1

Organization Secrets4

Organization Targets1

Organization Usage3

Organization Users5

Organizations4

Pricing1

Public Apps API5

Public Extractor Marketplace2

Public Notifications API1

Public Retriever API7

Public Templates API8

Published Retrievers8

Quickstart1

Resource Search1

Retriever API Keys3

Retriever Benchmarks4

Retriever Evaluations9

Retriever Interactions5

Retriever Learned Fusion10

Retriever Stages1

Retrievers15

Scaffold Templates3

Source Adapter2

Support14

Tasks3

Taxonomies13

Taxonomy Analytics6

Templates24

Triggers10

Webhooks5

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
        }
      }
    }
  ]
}

Changes

Changed in 4 of the 31 revisions of this API.212

Aug 21, 20261c7f318214242See the full diff
- ●
  added the new signal enum value to the results/items/response/anyOf[subschema #1: ListDocumentsResponse]/groups/anyOf[subschema #1]/items/documents/items/_internal/anyOf[subschema #1: InternalPayloadModel]/lineage/anyOf[subschema #1: InternalLineageModel]/source_type/anyOf[subschema #1]/ response property for the response status 200
  response-property-enum-value-added
- ●
  added the new signal enum value to the results/items/response/anyOf[subschema #1: ListDocumentsResponse]/results/anyOf[subschema #1]/items/_internal/anyOf[subschema #1: InternalPayloadModel]/lineage/anyOf[subschema #1: InternalLineageModel]/source_type/anyOf[subschema #1]/ response property for the response status 200
  response-property-enum-value-added
Aug 9, 20265d4c905106b41See the full diff
- ○
  the endpoint scheme security BearerAuth AND NamespaceHeader was added to the API
  api-security-added
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 4, 20269603dfdab4631See the full diff
- ○
  added the optional property results/items/response/anyOf[subschema #1: ListDocumentsResponse]/warnings to the response with the 200 status
  response-optional-property-added
Jul 26, 20267cb05153331110See the full diff
- ○
  added the new optional request property queries/items/request/include_total
  new-optional-request-property
- ○
  added the new geo_bounding_box enum value to the request property queries/items/request/filters/anyOf[subschema #1: LogicalOperator]/AND/anyOf[subschema #1]/items/anyOf[subschema #2: FilterCondition]/operator
  request-property-enum-value-added
- ○
  added the new geo_bounding_box enum value to the request property queries/items/request/filters/anyOf[subschema #1: LogicalOperator]/NOT/anyOf[subschema #1]/items/anyOf[subschema #2: FilterCondition]/operator
  request-property-enum-value-added
- ○
  added the new geo_bounding_box enum value to the request property queries/items/request/filters/anyOf[subschema #1: LogicalOperator]/OR/anyOf[subschema #1]/items/anyOf[subschema #2: FilterCondition]/operator
  request-property-enum-value-added
- ○
  added the new geo_polygon enum value to the request property queries/items/request/filters/anyOf[subschema #1: LogicalOperator]/AND/anyOf[subschema #1]/items/anyOf[subschema #2: FilterCondition]/operator
  request-property-enum-value-added
- ○
  added the new geo_polygon enum value to the request property queries/items/request/filters/anyOf[subschema #1: LogicalOperator]/NOT/anyOf[subschema #1]/items/anyOf[subschema #2: FilterCondition]/operator
  request-property-enum-value-added
- ○
  added the new geo_polygon enum value to the request property queries/items/request/filters/anyOf[subschema #1: LogicalOperator]/OR/anyOf[subschema #1]/items/anyOf[subschema #2: FilterCondition]/operator
  request-property-enum-value-added
- ○
  added the new geo_radius enum value to the request property queries/items/request/filters/anyOf[subschema #1: LogicalOperator]/AND/anyOf[subschema #1]/items/anyOf[subschema #2: FilterCondition]/operator
  request-property-enum-value-added
- ○
  added the new geo_radius enum value to the request property queries/items/request/filters/anyOf[subschema #1: LogicalOperator]/NOT/anyOf[subschema #1]/items/anyOf[subschema #2: FilterCondition]/operator
  request-property-enum-value-added
- ○
  added the new geo_radius enum value to the request property queries/items/request/filters/anyOf[subschema #1: LogicalOperator]/OR/anyOf[subschema #1]/items/anyOf[subschema #2: FilterCondition]/operator
  request-property-enum-value-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history