Generate Column

POST

/api/v2/workbooks/{workbook_id}/generate-column

curl --request POST \
  --url http://localhost:8000/api/v2/workbooks/example/generate-column \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "instruction": "example" }'

• Local API (uvicorn)
• Docker Compose (nginx front)

NL → column generator: turn an instruction into a validated, ready-to-add column config (formula / ai_formula / http). Does NOT add the column.

Authorizations

• OAuth2PasswordBearer

Parameters

Path Parameters

workbook_id

required

Workbook Id

string

Header Parameters

x-workspace-id

Any of:

string

string

null

null

Request Body^required

Media typeapplication/json

GenerateColumnRequest

NL → column generator: natural-language instruction to turn into a column.

object

instruction

required

Instruction

E.g. ‘extract the domain from the website URL’

string

>= 3 characters <= 2000 characters

Example^generated

{
  "instruction": "example"
}

Responses

200

Successful Response

Media typeapplication/json

GenerateColumnResponse

A validated, ready-to-add column config generated from an instruction.

object

column

required

ColumnConfig

Configuration for a single workbook column.

object

channels

Any of:

object

object

key

additional properties

any

null

null

condition

Any of:

string

string

null

null

destination

Any of:

string

string

null

null

destination_config

Any of:

object

object

key

additional properties

any

null

null

formula

Any of:

string

string

null

null

http_body

Any of:

Http Body

Http Body

Request body template (dict/str) for POST/PUT

null

null

http_extract

Any of:

string

string

null

null

http_headers

Any of:

object

object

key

additional properties

any

null

null

http_method

Any of:

string

string

null

null

http_url

Any of:

string

string

null

null

icp

Any of:

object

object

key

additional properties

any

null

null

id

required

Id

Unique column identifier

string

input_columns

Any of:

Array<string>

Array<string>

null

null

lead_field

Any of:

string

string

null

null

max_steps

Any of:

integer

integer

null

null

name

required

Name

Display name

string

output_format

Any of:

string

string

null

null

prompt

Any of:

string

string

null

null

provider

Any of:

string

string

null

null

target_field

Any of:

string

string

null

null

target_rows

Any of:

integer

integer

null

null

type

Type

Column type: lead_field, enrichment, waterfall, ai_formula, conditional, output

string

default: lead_field

verify

Any of:

boolean

boolean

null

null

waterfall

Any of:

Array<string>

Array<string>

null

null

width

Width

Column width in pixels

integer

default: 200

explanation

Explanation

string

""

kind

required

Kind

string

Allowed values: formula ai_formula http

Example

{
  "column": {
    "type": "lead_field",
    "width": 200
  },
  "explanation": "",
  "kind": "formula"
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

ctx

Context

object

input

Input

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example^generated

{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}