Skip to content

Start Ai Batch Enrichment

POST
/enrichment/ai/batch/enrich

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.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

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.

object
allow_credit_deduction

Accepted; not applied by dispatch.

boolean
default: true
dry_run
boolean
enrichment_mode
string
default: specific
Allowed values: specific all
filter
Any of:
object
key
additional properties
any
group_id
required
string
list_id
required
integer
model
Any of:
string
priority

Accepted; not applied by dispatch.

integer
<= 100
record_ids
Any of:
Array
skip_existing_values
boolean
skip_recently_enriched
boolean
default: true
usecase
Any of:
string

Responses

202

Successful Response

object
data
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.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string