Enrichment

Validate Ai Enrichment 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.

post/enrichment/ai/validate-credits

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/enrichment/ai/validate-credits
  • Auth: HTTP bearer

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

record_countinteger nullable

Direct record count.

modestring nullable

'bulk' or 'column'.

list_idinteger nullable
enrichment_modestring nullable

'first_10', 'all' or 'error_only'.

filter_modelobject nullable
sort_modelobject[] nullable
max_recordsinteger nullable
credits_per_recordinteger nullable

Deprecated. Pricing is computed server-side and this is ignored.

group_idstring nullable

AI enrichment group id.

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.