Enrichment

Start Ai Batch Enrichment

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.

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

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

list_idinteger required
group_idstring required
filterobject nullable

Accepted; not applied by dispatch.

enrichment_mode'specific' | 'all'
usecasestring nullable
modelstring nullable
allow_credit_deductionboolean

Accepted; not applied by dispatch.

dry_runboolean
priorityinteger

Accepted; not applied by dispatch.

skip_existing_valuesboolean
skip_recently_enrichedboolean

Response

Successful Response

dataEnrichmentPayload 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.

Changes

No recorded changes to this operation across all 2 revisions of this API.