Skip to content

Create Enrichment Configuration

POST
/enrichment/configs

Create an AI or waterfall configuration. Free: saving runs nothing.

The organisation and author always come from the API key; the app handler sets both itself and takes neither from the body.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Create an enrichment configuration.

The app takes this as a free dict and reads these keys. type is closed to the two the handler validates; ai requires group_id, prompt, model, usecase, input_mapping, outputs and column_mappings inside config, and waterfall requires column_id, field_to_enrich and config.steps.

object
column_id
Any of:
string
config
required
object
key
additional properties
any
data_type
string
default: text
field_to_enrich
Any of:
string
is_global
boolean
default: true
list_id
Any of:
integer
name
required
string
>= 1 characters
type
required
string
Allowed values: ai waterfall

Responses

201

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