Skip to main content
POST
Generate an enrichment column draft

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

One sentence to turn into a draft AI-column configuration.

instruction
string
required

A plain-language description of the column to build.

Required string length: 1 - 2000
table_id
string<uuid>
required

The table whose columns the prompt may reference.

Response

Successful Response

A generated draft configuration that seeds the column editor.

action_key
string
required
display_name
string
required
model_key
string | null
required

The suggested model; null keeps the catalog default.

output
EnrichmentOutputFields · object
required

The fields-mode output shape: repeatable named typed fields.

The default is Clay's: one text field named response.

prompt
EnrichmentPromptTemplate · object
required

The drafted prompt, with references to existing columns.

web_research
boolean
required

Whether the drafted task needs live web research. Always false for actions other than Use AI, which is the only one with a web-research switch to prefill.