Skip to main content
POST
Generate a formula column from a description

Authorizations

Authorization
string
header
required

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

Path Parameters

table_id
string<uuid>
required

Body

application/json

Request body for generating a formula definition from a description.

instruction
string
required

A natural-language description of the formula to build.

Required string length: 1 - 2000

Response

Successful Response

A generated formula definition, validated but NOT saved.

The caller reviews it — the same definition shape the editor produces by hand, so it flows into the existing preview and create endpoints unchanged.

data_type
enum<string>
required

The data type the generated chain produces.

Available options:
string,
integer,
float,
boolean,
datetime,
date,
list,
dict
definition
ManualColumnDefinition · object
required

Definition of a manual column: typed, user-editable cells.

explanation
string
required

One sentence describing what the chain does.

suggested_name
string
required

A proposed column name. The editor adopts it when the user has not named the column, so a generated formula is savable without a second step.