Skip to main content
POST
cURL

Авторизации

Authorization
string
header
обязательно

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

Параметры пути

tableId
string
обязательно

Тело

application/json
type
enum<string>
обязательно

The field types supported by teable.

Доступные опции:
singleLineText,
longText,
user,
attachment,
checkbox,
multipleSelect,
singleSelect,
date,
number,
rating,
formula,
rollup,
conditionalRollup,
link,
createdTime,
lastModifiedTime,
createdBy,
lastModifiedBy,
autoNumber,
button
Пример:

"singleSelect"

name
string
Minimum string length: 1
unique
boolean

Whether this field is not unique.

notNull
boolean

Whether this field is not null.

dbFieldName
string

Field(column) name in backend database. Limitation: 1-63 characters, can only contain letters, numbers and underscore, case sensitive, cannot be duplicated with existing db field name in the table.

Minimum string length: 1
Pattern: ^\w{0,63}$
isLookup
boolean

Whether this field is lookup field. witch means cellValue and [fieldType] is looked up from the linked table.

isConditionalLookup
boolean

Whether this lookup field applies a conditional filter when resolving linked records.

description
string | null

The description of the field.

Пример:

"this is a summary"

lookupOptions
object

The lookup options for field, you need to configure it when isLookup attribute is true or field type is rollup.

options
object

The options of the field. The configuration of the field's options depend on the it's specific type.

aiConfig

The AI configuration of the field.

id
string

The id of the field that start with "fld", followed by exactly 16 alphanumeric characters /^fld[\da-zA-Z]{16}$/. It is sometimes useful to specify an id at creation time

Пример:

"fldxxxxxxxxxxxxxxxx"

order
object

Ответ

201 - application/json

Returns the calculation plan for creating the field

estimateTime
number
обязательно
updateCellCount
number
обязательно
graph
object
Последнее изменение 4 сентября 2026 г.