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

Collections

Trigger Collection Processing

Process data through a collection - works for both bucket-sourced and collection-sourced collections.

**For bucket-sourced collections:**
Discovers objects from source bucket(s), creates a batch, and submits for processing.
Use `include_buckets` to limit which source buckets to process from.

**For collection-sourced collections:**
Processes existing documents from upstream collection(s).
Use `include_collections` to limit which source collections to process from.

**Filtering:**
- `source_filters`: Field-level filters using LogicalOperator format
- Example: `{"AND": [{"field": "status", "operator": "eq", "value": "pending"}]}`
- For specific objects: `{"AND": [{"field": "object_id", "operator": "in", "value": ["obj_1", "obj_2"]}]}`

**Returns:**
- batch_id: Track progress via GET /batches/{batch_id}
- task_id: Monitor via GET /tasks/{task_id}

post/v1/collections/{collection_identifier}/trigger

Path parameters

collection_identifierstring required

The ID or name of the collection to trigger

Request body

include_bucketsstring[] nullable

Limit processing to objects from these specific buckets (IDs or names). Only applies to bucket-sourced collections. If not provided, all configured source buckets are used.

include_collectionsstring[] nullable

Limit processing to documents from these specific collections (IDs or names). Only applies to collection-sourced collections. If not provided, all configured source collections are used.

object_idsstring[] nullable

Limit processing to these specific object IDs. Only applies to bucket-sourced collections. This is a convenience shorthand — equivalent to using source_filters with {"AND": [{"field": "object_id", "operator": "in", "value": [...]}]}.

dedup_strategy'skip' | 'replace' | 'force'

Controls how duplicate objects are handled during batch processing.

Dedup is scoped to (bucket_id, collection_id): an object is considered a duplicate if the target collection already has documents produced from the same source object in any prior batch.

Example request

{
  "source_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
  }
}

Response

Successful Response

batch_idstring required

ID of the created batch for tracking progress.

task_idstring required

Task ID for monitoring via GET /v1/tasks/{task_id}.

collection_idstring required

ID of the collection being processed.

source_bucket_idsstring[] nullable

Bucket IDs that objects were discovered from (bucket-sourced collections).

source_collection_idsstring[] nullable

Collection IDs that documents were read from (collection-sourced collections).

object_countinteger nullable

Total number of objects included in the batch (bucket-sourced collections).

document_countinteger nullable

Total number of documents to process (collection-sourced collections).

total_tiersinteger required

Number of processing tiers in the DAG.

messagestring required

Human-readable status message.

Changes

Changed in 2 of the 31 revisions of this API.10

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
Jul 26, 20267cb0515333119See the full diff
- ○
  added the new geo_bounding_box enum value to the request property source_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 source_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 source_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 source_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 source_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 source_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 source_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 source_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 source_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