---
title: "Start Ai Batch Enrichment"
method: POST
path: "/enrichment/ai/batch/enrich"
tags: ["Enrichment"]
---

# Start Ai Batch Enrichment

`POST /enrichment/ai/batch/enrich`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/enrichment/ai/batch/enrich`
- Auth: HTTP bearer

Run a saved AI group over a list. CHARGES per record.

`enrichment_mode: all` runs EVERY record in the list. Send `dry_run: true`
first: it returns the record count and credits per record and starts
nothing. Poll the returned job with `GET /enrichment/ai/batch/jobs/{job_id}/status`.

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Request body

- AIBatchEnrichmentRequest: Run a saved AI group over a list. CHARGES per record. `enrichment_mode: all` runs EVERY record in the list; `specific` runs only `record_ids`. `dry_run` returns the record count and price and dispatches nothing.
  - `list_id` integer, required
  - `group_id` string, required
  - `record_ids` union[], nullable
    - union
      - integer
      - string
      - string, uuid
  - `filter` object, nullable: Accepted; not applied by dispatch.
  - `enrichment_mode` 'specific' | 'all'
  - `usecase` string, nullable
  - `model` string, nullable
  - `allow_credit_deduction` boolean: Accepted; not applied by dispatch.
  - `dry_run` boolean
  - `priority` integer: Accepted; not applied by dispatch.
  - `skip_existing_values` boolean
  - `skip_recently_enriched` boolean

## Response `202`

Successful Response

- ApiResponseEnrichmentPayload
  - `data` EnrichmentPayload, required: One enrichment object, open-shaped. Open on purpose: a workbench column set is defined by the CUSTOMER at runtime, and the enrichment result shapes grow with every provider added. Pinning them would drop whatever a provider returned that this contract had not caught up on, which on an enrichment surface is the data the customer paid for.
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/89fc11143b70?raw)