Skip to content

Validate Ai Enrichment Credits

POST
/enrichment/ai/validate-credits

Price an AI enrichment before running it. CHARGES NOTHING.

Resolves how many records the scope covers, what the group’s usecase costs per record, and whether the balance covers it. Call it first: this is the only way to learn the price without paying it.

The scope fields mirror the run’s exactly, so the same body prices what the run would then do. A body that names no scope prices the whole list.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Price an AI enrichment before running it. Charges nothing.

object
context_record_ids
Any of:
Array
credits_per_record
Any of:
integer
>= 1
enrichment_mode
Any of:
string
filter_model
Any of:
object
key
additional properties
any
group_id
Any of:
string
list_id
Any of:
integer
max_records
Any of:
integer
>= 1
mode
Any of:
string
record_count
Any of:
integer
>= 1
record_ids
Any of:
Array
sort_model
Any of:
Array<object>
object
key
additional properties
string
visible_record_ids
Any of:
Array

Responses

200

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