Skip to content

Generate Enrichment Prompt

POST
/enrichment/generate-prompt

Write an enrichment prompt from a list’s columns. COSTS AN AI CALL.

A model reads the list’s columns and sample rows and drafts a prompt for the task you describe. The result is a draft - nothing is configured and no record is enriched until you save it.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Ask the model to write an enrichment prompt from a list’s columns.

object
list_id
required
integer
task_description
required
string

Responses

200

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