Skip to content

Create List Pipeline

POST
/enrichment/lists/{list_id}/pipelines

Create a pipeline of enrichment steps on a list. CAN ARM SPEND.

enabled defaults to false. Set to true, the pipeline runs its steps over the list, and each enrichment step charges per record. Price it first with POST .../pipelines/{pipeline_id}/estimate. An inline_config step creates the AI or waterfall column it needs as part of the save.

Authorizations

Parameters

Path Parameters

list_id
required
integer

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Create a list pipeline.

enabled: true ARMS it: an enabled pipeline runs its steps over the list, and every enrichment step charges.

object
enabled
boolean
name
required
string
>= 1 characters <= 255 characters
steps
required
Array<object>
>= 1 items <= 20 items

One step. Exactly one of config_ref or inline_config.

object
config_ref

An existing config’s group or column id.

string
"" <= 255 characters
enabled
boolean
default: true
id
required
string
>= 1 characters <= 64 characters
inline_config
Any of:
One of: discriminator: kind

Create a new AI column as part of saving the pipeline.

object
kind
required
string
model
string
default: openai/gpt-4o-mini <= 120 characters
outputs
required
Array<object>
>= 1 items <= 10 items
object
name
required
string
>= 1 characters <= 50 characters /^[a-z][a-z0-9_]*$/
type
string
default: Text
Allowed values: Text Number Boolean
prompt
required
string
>= 10 characters <= 20000 characters
scope
Any of:
string
Allowed values: contact company
usecase
string
default: create-modify-content
Allowed values: create-modify-content content-generation web-research
name
string
"" <= 255 characters
run_condition
Any of:
string
<= 2000 characters
skip_existing_values
boolean
default: true
skip_recently_enriched
boolean
default: true
type
required
string
Allowed values: ai waterfall
ui_meta
Any of:
object
key
additional properties
any

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