Enrichment

Validate Waterfall Enrichment Credits

Price a waterfall enrichment before running it. CHARGES NOTHING.

A waterfall tries providers in order until one answers, so the price depends on which providers the column is configured with. credits_per_ record in the body is a deprecated field the server ignores - pricing is computed from the configuration, not from what the caller claims.

post/enrichment/waterfall/validate-credits

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/enrichment/waterfall/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.

column_idstring required

Waterfall enrichment column 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