Skip to content

Create Workbench Pipeline

POST
/workbench/tables/{table_id}/pipelines

Create a pipeline that processes new rows step by step. CAN ARM SPEND.

enabled defaults to false. Enabled, it runs its AI and waterfall steps - each charged per row - on every row that arrives.

Authorizations

Parameters

Path Parameters

table_id
required

Workbench table id (UUID).

string

Workbench table id (UUID).

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Create a workbench pipeline. enabled: true ARMS it on every new row.

object
enabled
boolean
name
required
string
start
required

What starts the pipeline.

object
expected_fields
Array<object>
object
data_type
string
default: text
Allowed values: text number boolean json
display_name
string
"" <= 255 characters
locked
boolean
name
required
string
>= 1 characters <= 255 characters
source_types
Array<string>
type
required
string
Allowed values: email_pdf webhook scraper_bot ingest
steps
Array<object>

One step. A branch step runs if_steps or else_steps.

object
column_id
Any of:
integer
conditions
Any of:
Array<object>
object
key
additional properties
any
else_steps
Array<object>

A step inside a branch.

Its own if_steps / else_steps are open objects in this schema: the app nests steps without limit, and a self-referencing schema is not publishable. They are still validated as steps by the app.

object
column_id
Any of:
integer
conditions
Any of:
Array<object>
object
key
additional properties
any
else_steps
Array<object>
object
key
additional properties
any
enabled
boolean
default: true
group_id
Any of:
string
id
required
string
>= 1 characters <= 255 characters
if_steps
Array<object>
object
key
additional properties
any
inline_config
Any of:
object
key
additional properties
any
name
required
string
>= 1 characters <= 255 characters
template
Any of:
string
type
required
string
Allowed values: ai_group waterfall formula branch export_to_list
enabled
boolean
default: true
group_id
Any of:
string
id
required
string
>= 1 characters <= 255 characters
if_steps
Array<object>

A step inside a branch.

Its own if_steps / else_steps are open objects in this schema: the app nests steps without limit, and a self-referencing schema is not publishable. They are still validated as steps by the app.

object
column_id
Any of:
integer
conditions
Any of:
Array<object>
object
key
additional properties
any
else_steps
Array<object>
object
key
additional properties
any
enabled
boolean
default: true
group_id
Any of:
string
id
required
string
>= 1 characters <= 255 characters
if_steps
Array<object>
object
key
additional properties
any
inline_config
Any of:
object
key
additional properties
any
name
required
string
>= 1 characters <= 255 characters
template
Any of:
string
type
required
string
Allowed values: ai_group waterfall formula branch export_to_list
inline_config
Any of:
object
key
additional properties
any
name
required
string
>= 1 characters <= 255 characters
template
Any of:
string
type
required
string
Allowed values: ai_group waterfall formula branch export_to_list

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