Enrichment

Generate Ai Run Condition

Turn a rule in words into a run condition. SPENDS CREDITS, TOKEN-METERED.

"Only run for CEOs with no work email" becomes an expression you can put in a config's run_condition, so the enrichment skips rows it should not touch - which is how this pays for itself.

The charge is METERED ON TOKENS rather than flat: a long rule with a large sample record costs more than a short one. Keep sampleData to a single representative record.

post/enrichment/ai-formula/generate-condition

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/enrichment/ai-formula/generate-condition
  • Auth: HTTP bearer

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

promptstring nullable

The rule in plain words.

fieldsstring[] nullable

Fields the expression may use.

sampleDataobject nullable

One sample record.

entityTypestring nullable

'contacts' or 'companies'.

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 3 revisions of this API.