The base URL for the AITable API request is https://aitable.ai.

Note: https requests must be used, not http requests.

The AITable API follows the RESTful API convention as much as possible, i.e. data is added, deleted, and checked via GET, POST, PATCH, and DELETE requests to the space and AITable resources.

The request and response bodies are encoded in JSON format.

The parameter names in JSON use camel naming (e.g. viewId) and are case sensitive.

Way 1: By API token

API Token is the user authentication token.When you send an API request to the AITable server, you must include Authorization: Bearer {Your API Token} in the request header to facilitate the server's authentication of the user's identity.

After successful authentication, this API request will have the same privileges as the user's operations in the AITable interface, i.e. whatever data the user can operate on the interface, this request can also operate on it.

Take the following cURL request as an example.

curl "https://aitable.ai/fusion/v1/datasheets/{datasheetId}/records" \
  -H "Authorization: Bearer {Your API Token}" \

Its request header includes.

Name	Data Type	Required	Format of Value	Example Value
Authorization	String (string)	Yes	Bearer {Your API Token}	Bearer uskYtInkHozfsMikhh0yfoS

For specific authentication operations, please refer to Quick Start

Way 2: OAuth2 (WIP)

When sending API requests, you need to be aware of several restrictions: frequency restrictions, interface restrictions, usage restrictions.

Frequency limits

Different space levels will have the following API request rates limits when requesting the API using user tokens:

• Free space: 2 QPS, suitable for API learning and experience.
• Plus space: 5 QPS, suitable for personal application development.
• Pro space: 10 QPS, suitable for team application development and operation.
• Enterprise space: 20 QPS, suitable for enterprise-level internal application development and high-concurrency scenarios.

Click to view the pricing page of AITable

If the request frequency exceeds the limit, an error "Operation too frequent" will be displayed (error status code 429).

API limits

• Get records interface: Get up to 1000 rows of records at a time.
  For example, if you want to fetch 10000 rows of records in bulk, you need to call the Get Records interface at least 10 times.
  
  
• Create records interface: Create up to 10 rows of records at a time.
  For example, if you want to create 1000 rows of records in a batch, you need to call the Create Record interface at least 100 times.
  
  
• Update records interface: update up to 10 rows of records at a time.
  For example, if you want to update 1000 rows of records in a batch, you need to call the Update Record interface at least 100 times.
  
  
• Delete records interface: Delete up to 10 rows of records at a time.
  For example, if you want to delete 1000 rows of records in a batch, you need to call the Delete Record interface at least 100 times.
  
  
• Upload attachments interface: only 1 attachment can be uploaded at a time. If you need to upload multiple files, you need to call this interface repeatedly.

Usage limits

There are two types of usage limits: one is the limit of API usage; the other is the limit of space resource usage, for details, please refer to pring page.

The maximum capacity of uploading attachments to a single space is 1 GB.

Each time you send an API request, the application returns a business status code and a corresponding message.

If the request fails, you can troubleshoot it based on the status code and error message returned.

HTTP Status Code	Response Message	Business Status Code	Description
200	SUCCESS	200	GET, PATCH, DELETE requests work and return results as expected
201	SUCCESS	200	POST request works and returns results as expected
200	Cannot find the specified datasheet	301	Possible scenarios: 1) The datasheet may have been deleted 2) The user cannot find the datasheet in their own space list
200	Failed to upload attachment	426	Possible scenarios: ① Attachments exceed the 1 GB size limit ② The space has reached its maximum attachment capacity
200	The number of uploaded attachments exceeds the limit	428	Upload attachments can only upload one per call, beyond this error will be reported
200	Operation without node permission	602	Users do not have access rights to the specified datasheet (e.g., manageable, editable, or read-only)
200	(Refer to the specific error message)	400	Parameter exception, data verification exception
401	Authentication failure	401	Possible scenarios: ① API Token is not passed in the request header ② API Token is incorrect
403	Prohibit access	403	Possible scenarios: ① The number of API calls has exceeded the limit ② Unable to get the API usage quota for the space, please try again later
404	Interface does not exist	404	Please check if the request address is correct
429	Operate too often	429	The maximum request Different space levels will have the following API request rates limits,you can read the AITable pricing page
500	SERVER_ERROR (code)	500	Unhandled exceptions for internal services
200	You have exceeded the "Public Beta" limit of 50,000 lines	304	The number of rows in the table has reached the maximum number of rows in a single table, please replace the number of tables as soon as possible to avoid data loss

At the present time, AITable is open to the interfaces of getting records, creating records, updating records and deleting records.

The data structure of the records is as follows.

Properties	Description
recordId	string record ID e.g. "rec1jV9eWxcaB"
createdAt	number The creation time of the record, in timestamp format e.g. 1624960629000
updatedAt	number The modification time of this record, in timestamp format e.g. 1624964696000
fields	object the data of the corresponding field in a record, returned in the format {"fieldName": fieldValue}

When using the Create Records or Update Records API to write to fields, you need to understand the data type and structure of each field value.

Note: calculated fields do not allow values to be written actively, including: AutoNumber, Formula, MagicLookUp, LastModifiedTime, CreatedTime, LastModifiedBy, CreatedBy, etc.

For reference,the following table lists the values of different types of fields:

Field Types	Description
SingleText	string returns a string without "\n" line breaks e.g. {"fieldName": "an example title"}
Text	string returns a string with "\n" line breaks e.g. {"fieldName": "a long text"}
SingleSelect	string returns the selected option as a string e.g. {"fieldName": "done"}
MultiSelect	array of strings returns the selected options as an array of strings e.g. "{"fieldName": ["Option1", "Option2"]}
Number	number returns a positive or negative number. The return result will not include the precision or symbol given in the field settings. e.g. "{"fieldName": 1998}
Currency	number returns a positive or negative number. The return result will not include the precision or symbol given in the field settings. e.g. "{"fieldName": 999}
Percent	number returns a positive or negative number. The return result will not include the precision or symbol given in the field settings. e.g. "{"fieldName": 0.1}
DateTime	number returns a timestamp in milliseconds e.g. "{"fieldName": 1678723200000}
Attachment	array of attachment objects returns an array of attachment objects. Each object includes the following properties: 1. mimeType (string): the media type of the attachment; 2. name (string): the name of the attachment; 3. size (number): the size of the attachment (byte); 4. width (number): the width of the image (px), if the attachment is an image; 5. height (number): the height of the image (px), if the attachment is an image; 6. token (string): the access path of the attachment; 7. preview (string): the preview image URL that you can open in a browser, if the attachment is a PDF e.g. {"fieldName":[{"id":"atcFagvJrELTS","name":"logo.png","size":6396,"mimeType":"image/png","token":"space/2023/03/17/ee1bb79d3fd847e383e21c9b0bd53dfc","width":424,"height":80,"url":"https://legacy-s1.aitable.ai/space/2023/03/17/ee1bb79d3fd847e383e21c9b0bd53dfc"}]}
Member	array of unit objects returns an array of unit objects. A unit describes the roles in a Space such as a member or a team. - id: string, the ID of the organizational unit - type: number, the type of organizational unit, 1 is the group, 3 is the member - name: string, the name of the group or member - avatar: string, avatar URL, read-only, not writable e.g. {"fieldName":[{"id":"1291258301781176321","type":3,"name":"Jane","avatar":"https://s1.aitable.ai/space/2023/02/09/79e112dd10424ac7842256736e4f5568"}]}
Checkbox	boolean returns true as boolean format if the checkbox is checked. Otherwise the return result will not include this Checkbox field. e.g. {"fieldName": true}
Rating	number returns a positive number between 1 and 10. The return result will not include this field if the value is empty. e.g. {"fieldName": 5}
URL	url object returns a URL object, including title (webpage title), text (webpage address), favicon (webpage icon) e.g. {"fieldName":{"title":"AITable","text":"https://aitable.ai","favicon":"https://legacy-s1.aitable.ai/space/2022/12/08/f8693e8f39774a1c8f0b937f39da0e17"}}
Phone	string returns a phone number as a string e.g. {"fieldName": "(310) 3xx-5xxx"}
Email	string returns a email address as a string e.g. {"fieldName": "support@aitable.ai"}
WorkDoc	array of workdoc objects returns an array of workdoc objects. Each object includes the following properties: - documentId : string，document ID - title: string，document title e.g. {"fieldName":[{"documentId":"docCqiLTtyx4l","title":"I am title"}]}
OneWayLink	array of record IDs (strings) returns an array of strings. Each string is the ID of a record that is added into the One-way link field. e.g. {"fieldName": ['recz9eeg61SEa']}
TwoWayLink	array of record IDs (strings) returns an array of strings. Each string is the ID of a record that is added into the Two-way link field. e.g. {"fieldName": ['recz9eeg61SEa']}
MagicLookUp	array of any returns a number, string, or array. The Lookup result is calculated by the system. You can't write into the Lookup field by API. e.g. {"fieldName": ['Reference data 1', 'Reference data 2']}
Formula	string | number | boolean returns a number, string, or boolean result. The formula result is calculated by the system. You can't write into the Formula field by API.
AutoNumber	number returns a positive number. The system automatically generates the numbers so you can't write into the field by API. e.g. {"fieldName": 1}

The data structure of the fields is as follows.

Properties	Description
id	string, field ID Example values: fldsRHWJZwFcM
name	string, field name Example values: Order number
type	string, Field types, possible values are listed in the section Field Types and Attributes Example values: SingleText
editable	boolean, Field permissions, i.e. column permissions, true for editable, false for read-only Example values: true
property	object,Field attributes.Different fields have different attributes, see the section Field Types and Attributes for details on the attributes of various fields Example values: {"defaultValue":"To be added"}
isPrimary	boolean, Is the primary field Example values: true
desc	string, Field descriptions, i.e. column descriptions Example values: This column is the automatic generation of the single number, do not manually modify

Field Types and Attributes

AITable currently has the following field types.

The type of field returned by the interface	The type of the corresponding field
SingleText	single-line text
Text	Multi-line text
SingleSelect	Single choice
MultiSelect	Multiple choice
Number	Number
Currency	Currency
Percent	Percentage
DateTime	Datetime
Attachment	Attachment
Member	Member
Checkbox	Check
Rating	Rating
URL	Website
Phone	A telephone number.
Email	Email
WorkDoc	WorkDoc
OneWayLink	One-way link
TwoWayLink	Two-way link
MagicLookUp	MagicLookUp
Formula	Intelligent formula
AutoNumber	Autoincrement number
CreatedTime	Create Timestamp
LastModifiedTime	Modify Timestamp
CreatedBy	Created by
LastModifiedBy	Updated by
Button	Button

The following section describes the properties of each field type in detail.

When the "Get Field" interface is called, the following results are returned for each field type.

SingleText

Return a sample fragment of the result (containing only field types and attributes).

{
  "type": "SingleText",
  "property": {
    "defaultValue": ""
  }
}

Field Properties	Data Type	Description
defaultValue	string	When creating a new record, the default value of the corresponding cell of this field, the default is empty

Text

No field properties are available at this time.

SingleSelect

Return a sample fragment of the result (containing only field types and attributes).

{
  "type": "SingleSelect",
  "property": {
    "options": [
      {
        "id": "optpTVSGk0R2M",
        "name": "Elevit",
        "color": {
          "name": "indigo_4",
          "value": "#5586FF"
        }
      },
      {
        "id": "optqX2Bw479FG",
        "name": "OAD",
        "color": {
          "name": "blue_4",
          "value": "#55CDFF"
        }
      }
    ]
  }
}

Field Properties	Data Type	Description
options	object arrays	List of all available options

Description of the parameters contained under options.

Parameters	Data Type	Description
id	string	option ID
name	string	option name
color	object	The color of the option, including the name and value of the color

MultiSelect

The field properties are the same as the radio selection.

Number

Return a sample fragment of the result (containing only field types and attributes).

{
  "type": "Number",
  "property": {
    "defaultValue": "2",
    "precision": 0,
    "commaStyle": ",",
    "symbol": "Square meters"
  }
}

Field Properties	Data Type	Description
defaultValue	string	The default value for this field when creating a new record, default is empty.
precision	number	Indicates the number of decimal places, i.e., the precision of the number.The values are 0 (for integers), 1 (to one decimal place), 2 (to two decimal places), 3 (to three decimal places), 4 (to four decimal places)
commaStyle	string	Thousand separator, set this property to separate thousands of digits by a comma, such as 1,000.default is empty (optional)
symbol	string	numeric units, displayed to the right of the number, default is null (optional)

Currency

Return a sample fragment of the result (containing only field types and attributes).

{
  "type": "Currency",
  "property": {
    "defaultValue": "1000.00",
    "precision": 2,
    "symbol": "¥",
    "symbolAlign": "Default"
  }
}

Field Properties	Data Type	Description
defaultValue	string	The default value for this field when creating a new record, the default is null.
precision	number	Indicates the number of decimal places, i.e., the precision of the number.The values are 0 (for integers), 1 (to one decimal place), 2 (to two decimal places), 3 (to three decimal places), 4 (to four decimal places)
symbol	string	currency symbol, can be any custom character
symbolAlign	string	currency symbol (optional).The default value is Default (the currency unit is immediately to the left of the value), other values are Left (the currency unit is fixed to the left), Right (the currency unit is fixed to the right).

Percent

Return a sample fragment of the result (containing only field types and attributes).

{
  "type": "Percent",
  "property": {
    "defaultValue": "0.85",
    "precision": 1
  }
}

Field Properties	Data Type	Description
defaultValue	string	The default value of the cell corresponding to this field when creating a new record, the default is empty.
precision	number	Indicates the number of decimal places to convert the field value to a percentage, i.e., the percentage precision.The values are 0 (for integers), 1 (to one decimal place), 2 (to two decimal places), 3 (to three decimal places), 4 (to four decimal places).For example, if the field value is 0.22, it will be displayed as 22% if the percentage precision is 0. If the percentage precision is 1, it will be displayed as 22.0%

Datetime

Return a sample fragment of the result (containing only field types and attributes).

{
  "type": "DateTime",
  "property": {
    "dateFormat": "YYYY/MM/DD hh:mm",
    "includeTime": true,
    "timeFormat": "hh:mm",
    "autoFill": true,
    "timeZone": "Asia/Hongkong",
    "includeTimeZone": true
  }
}

Field Properties	Data Type	Description
dateFormat	string(enum)*	YYYY/MM/DD, YYYY-MM-DD, DD/MM/YYYY, YYYY-MM, MM-DD, YYYY, MM, DD
includeTime	Boolean	Whether to display the time
timeFormat	string(enum)	HH:mm, hh:mm
autoFill	Boolean	Whether to auto-fill the time when creating a new record
timeZone	String	Time zone
includeTimeZone	Boolean	Whether to display time zone

The value of the date field returns timestamp without restricted format.The format information in the field property can be used for formatting, see dayjs format for the meaning.

If you don't want to handle date formatting and want the returned result to be consistent with the view display, you can assign cellFormat to string in the interface request parameters, and all the returned content will be a string.

For available values for timeZone property, please refer to List of Time Zones. Example: Asia/Shanghai。

Attachment

No field properties are available at this time.

Member

Return a sample fragment of the result (containing only field types and attributes).

{
  "type": "Member",
  "property": {
    "isMulti": true,
    "shouldSendMsg": true
  }
}

Field Properties	Data Type	Description
isMulti	Boolean	If or not multiple members can be selected
shouldSendMsg	Boolean	Whether to send an in-site message to a member when it is mentioned in the member column

Description of the parameters contained under options.

Parameters	Data Type	Description
id	String	The user's organizational unit id (different from the actual user id) on the current space, hereafter referred to as the member id. e. g.Bob's member id on space A is different from his member id on space B
name	String	member name
type	String	member type, including Member (for users with physical accounts) and Team (for organizational units in the space, such as departments, groups, etc.)
avatar	String	URL of the member's avatar

Checkbox

Return a sample fragment of the result (containing only field types and attributes).

{
  "type": "Checkbox",
  "property": {
    "icon": "white_check_mark"
  }
}

Field Properties	Data Type	Description
icon	string(enum)	Please refer to Expression Pack Enumeration

Rating

Return a sample fragment of the result (containing only field types and attributes).

{
  "type": "Rating",
  "property": {
    "icon": "star",
    "max": 5
  }
}

Field Properties	Data Type	Description
icon	string(enum)	Please refer to Expression Pack Enumeration
max	Number	The maximum value of the rating, from 1-10

URL

No field properties are available at this time.

Phone

No field properties are available at this time.

Email

No field properties are available at this time.

WorkDoc

No field properties are available at this time.

OneWayLink

Two datasheets A and B are connected by a link field, and there will be an association field in A that is associated with B.

Return a sample fragment of the result (containing only field types and attributes).

{
  "type": "OneWayLink",
  "property": {
    "foreignDatasheetId": "dstgr2YN264s7CXKVs",
    "limitToViewId": "viwY4B8pmiMoi",
    "limitSingleRecord": true
  }
}

Field Properties	Data Type	Description
foreignDatasheetId	String	Related datasheet ID
limitSingleRecord	Boolean	Whether to select only a single record
limitToViewId	String	Specifies a view of the associated datasheet, limiting the selection to the records under that view

TwoWayLink

Two datasheets A and B are connected by a link field, and there will be an association field in A that is associated with B, and a link field in B that is associated with A.This pair of related fields is called a brother field.

Return a sample fragment of the result (containing only field types and attributes).

{
  "type": "TwoWayLink",
  "property": {
    "foreignDatasheetId": "dstgr2YN264s7CXKVs",
    "brotherFieldId": "fldxxxxxxxx",
    "limitToViewId": "viwY4B8pmiMoi",
    "limitSingleRecord": true
  }
}

Field Properties	Data Type	Description
foreignDatasheetId	String	Related datasheet ID
brotherFieldId	String	Related field ID
limitSingleRecord	Boolean	Whether to select only a single record
limitToViewId	String	Specifies a view of the associated datasheet, limiting the selection to the records under that view

MagicLookUp

The MagicLookUp field is a field attached to a OneWayLink or TwoWayLink field. It is a dynamic computed field, and the cell itself does not store any value.

Return a sample fragment of the result (containing only field types and attributes).

{
  "type": "MagicLookUp",
  "property": {
    "relatedLinkFieldId": "fldhBGpM3ylTq",
    "targetFieldId": "fldS2mgS18LE1",
    "rollupFunction": "VALUES",
    "valueType": "Array",
    "entityField": {
      "datasheetId": "dstgr2YN264s7CXKVs",
      "field": {
        "id": "fldS2mgS18LE1",
        "name": "title",
        "type": "SingleText",
        "property": {
          "defaultValue": ""
        },
        "editable": true
      }
    },
    "enableFilterSort": true,
    "sortInfo": {
      "rules": [
        {
          "fieldId": "fld7aautAK1h",
          "desc": false
        }
      ]
    },
    "filterInfo": {
      "conjunction": "and",
      "conditions": [
        {
          "fieldId": "fldL74kjFHak",
          "fieldType": "Number",
          "operator": "isGreater",
          "value": [13]
        }
      ]
    },
    "lookUpLimit": "ALL"
  }
}

Field Properties	Data Type	Description
relatedLinkFieldId	String	The associated field ID of the referenced current datasheet
targetFieldId	String	the field ID of the queried field in the associated datasheet
hasError	Boolean	When a lookup dependent associated field is deleted or converted, the referenced value may not be retrieved properly
entityField	Object	The entity fields are finally referenced, excluding MagicLoopUp fields.If an error exists, the entity field may not exist.
rollupFunction	String	aggregate function
valueType	String	Return value type, including String, Boolean, Number, DateTime, Array
format	Object	Returns the result of a number or date formatting operation when the return value is of type Number or DateTime

• Description of the rollupFunction values refer to Lookup Product Manual for the meaning of the parameters.

  Function Name	Return Value Type	Description
  VALUES	array	Original values
  AVERAGE	number	average
  COUNT	number	non-null count
  COUNTA	number	non-null value count
  COUNTALL	number	full count
  SUM	number	Total
  MIN	number/datetime	minimum
  MAX	number/datetime	maximum
  AND	boolean	and operation
  OR	boolean	or operation
  XOR	boolean	eXclusive OR operation
  CONCATENATE	string	concatenate to text
  ARRAYJOIN	string	comma-join
  ARRAYUNIQUE	array	Deduplication
  ARRAYCOMPACT	array	filter all null values

• Description of the parameters contained under entityField.

  Parameters	Data Type	Description
  datasheetId	String	the datasheet ID of the entity field
  field	Object	A Field object other than LookUp, a MagicLookUp can refer to a field of a MagicLookUp type from another datasheet, but ultimately an entity field will exist.

  Note: If you use this field feature in your application, you will need to handle exceptions when a reference error is detected for the field.

• The parameters included under format are described below.

  Parameters	Data Type	Description
  type	String	formatting type DateTime, Number, Percent, Currency
  format	Object	The specific format of the different formatting types

  Formatted as date.

  Parameters	Data Type	Description
  dateFormat	String	Date format, e.g. YYYY/MM/DD
  timeFormat	String	Time format, e.g. hh:mm, HH:mm
  includeTime	Boolean	Whether to display the time
  timeZone	String	Time zone
  includeTimeZone	Boolean	Whether to display time zone

  Formatted as a number or percentage:

  Parameters	Data Type	Description
  precision	Number	numeric precision or percentage precision

  Formatted as currency:

  Parameters	Data Type	Description
  precision	Number	Precision
  symbol	String	currency symbol

• Explanation of parameters contained in sortInfo:

  Parameters	Data Type	Description
  rules	array	An array of sorting rules. Currently, only one sorting rule can be specified (the array can only have one element).

  Explanation of parameters contained in the rules array:

  Parameters	Data Type	Description
  fieldId	string	The ID of the field used for sorting.
  desc	boolean	Whether to sort in descending order.

• Explanation of parameters contained in filterInfo:

  Parameters	Data Type	Description
  conjunction	string	Combination mode of filter conditions: and requires all filter conditions to be met; or requires any one filter condition to be met.
  conditions	array	Array of filter conditions

  Explanation of parameters contained in conditions:

  Parameters	Data Type	Description
  fieldId	string	Field ID of the filter field
  fieldType	string	Field type of the filter field
  operator	string	Operator of the filter condition. See the table below for available values.
  value	array	Reference value of the filter condition. For example, if the filter condition is "greater than 3", the reference value is 3, and the value would be [3].

  Explanation of possible values for operator:

  Value	Description
  is	Filters the field whose value is equal to the reference value
  isNot	Filters the field whose value is not equal to the reference value
  contains	Filters the field whose value contains the reference value
  doesNotContain	Filters the field whose value does not contain the reference value
  isEmpty	Filters the field whose value is empty
  isNotEmpty	Filters the field whose value is not empty
  isGreater	Filters the field whose value is greater than the reference value
  isGreaterEqual	Filters the field whose value is greater than or equal to the reference value
  isLess	Filters the field whose value is less than the reference value
  isLessEqual	Filters the field whose value is less than or equal to the reference value
  isRepeat	Filters the field whose value contains duplicate items

• Explanation of possible values for lookUpLimit:

  Value	Description
  ALL	Displays all referenced record values.
  FIRST	Displays only the first referenced record value.

Formula

Return a sample fragment of the result (containing only field types and attributes).

{
  "type": "Formula",
  "property": {
    "expression": "",
    "valueType": "String",
    "hasError": false
  }
}

Field Properties	Data Type	Description
expression	string*	formula expression
valueType	string(enum)*	Return value type, including String, Boolean, Number, DateTime, Array
hasError	boolean	The calculated value may not be retrieved properly when the relevant field dependent on the formula is deleted or converted.
format	object	When the return value is of type Number or DateTime, it returns a number or date formatted in the same format as the lookup.

Same as magiclookup, exceptions need to be handled when errors are encountered.

AutoNumber

DescriptionNo field properties are available at this time.

CreatedTime

Same as DateTime.

LastModifiedTime

Same as DateTime.

CreatedBy

The member id is at the space level and the creator id is at the account level.

Return a sample fragment of the result (containing only field types and attributes).

{
  "type": "CreatedBy",
  "property": {
    "options": [
      {
        "id": "e9cbc839fd1b49be85b1f7b0977047e2",
        "name": "Coco",
        "avatar": "https://s1.aitable.ai/default/avatar004.jpg"
      }
    ]
  }
}

Field Properties	Data Type	Description
options	option[]	Members whose fields have been selected by the current member

Description of the parameters contained under options.

Parameters	Data Type	Description
id	string*	user id
name	string*	user nickname
avatar	string*	URL of user avatar

LastModifiedBy

Return a sample fragment of the result (containing only field types and attributes).

{
  "type": "LastModifiedBy",
  "property": {
    "options": [
      {
        "id": "e9cbc839fd1b49be85b1f7b0977047e2",
        "name": "Coco",
        "avatar": "https://s1.aitable.ai/default/avatar004.jpg"
      }
    ]
  }
}

Field Properties	Data Type	Description
options	option[]	Current field stored users

Description of the parameters contained under options.

Parameters	Data Type	Description
id	string*	user id
name	string*	user nickname
avatar	string*	URL of user avatar

Button

Return a sample fragment of the result (containing only field types and attributes).

{
  "id": "fldb6L4FznMbZ",
  "name": "Button",
  "type": "Button",
  "property": {
    "text": "Click to start",
    "style": {
      "type": "Background",
      "color": {
        "name": "deepPurple_5",
        "value": "#B0A4F5"
      }
    },
    "action": {
      "type": "openLink",
      "openLink": {
        "type": "Url",
        "expression": "https://aitable.ai"
      }
    }
  },
  "editable": false
}

Field Properties	Data Type	Description
text	String	Button text
style	Object	Button style
action	Object	Button action

• Explanation of parameters contained in style:

Parameters	Data Type	Description
type	String	Button style type: Background, OnlyText. \n Default is Background
color	Object	Button style color

• Explanation of parameters contained in color:

Parameters	Data Type	Description
name	String	Color name, see the name of color value list for details
value	String	Color value, not required. See the name of color value list for details

• Explanation of parameters contained in action:

Parameters	Data Type	Description
type	String	Button action type: OpenLink, TriggerAutomation. Currently only OpenLink support for now in the API
openLink	Object	Click to open a link

• Explanation of parameters contained in openLink:

Parameters	Data Type	Description
type	String	Link type: Url, Expression
expression	String	Pure url or The expression of the url

The data structure of view is as follows.

Attributes	Description
id	string* ID of view e.g. viwpdA8TUBp5r
name	string* Name of view e.g. All Orders
type	string(enum)* Grid, Gallery, Kanban, Gantt, Calendar, Architecture e.g. Grid

At the moment, only the interface for creating tables is open for AITable.

Currently the AITable is only open for uploading attachments.

The data structure of space is as follows.

Attributes	Description
id	string* ID of space e.g. spcX9P2xUcKst
name	string* Name of space e.g. test space
isAdmin	boolean whether the current requesting user is the admin of the space e.g. true

The data structure of single file node is as follows.

Attributes	Description
id	string* ID of file node e.g. fodvfSPGFPmFH
name	string* Name of file node e.g. R&D Department
icon	string Icon of file node e.g. 🤠
type	string(enum)* Datasheet, Mirror, Folder, Form, Dashboard, Automation e.g. Folder
isFav	boolean Pin status. This parameter indicates whether the current node is pinned to the "Pin" section in the left sidebar e.g. true
permission	number API tokens are generated based on individual accounts. Users can retrieve a list of file nodes that they have specific permissions for using the API token.. 0: Manager, able to add, delete views and records field, and allowed to edit fields, but nable to add and delete fields. 1: Editor, able to add, delete views and records field, and allowed to edit fields, but unable to add and delete fields. 2: Update-only, able to view, add and edit records, but unable to delete records. 3: Read-only, only allowed to view the data. For more details about file node permissions can be found here: https://help.aitable.ai/docs/guide/faq-permission-settings e.g. 0
children	array of nodes Only returned when Get Node Details is requested。The children information will only be returned when the file type is Folder. Under children, there is a list of file nodes in the folder one level down. e.g. [{"id":"fodwrbgo8lDpbUjZzm","name":"Procurement management","type":"Folder","icon":"🤠","isFav":true},{"id":"fodwrbgo8lDpbUjZzm","name":"Procurement management","type":"Folder","icon":"🤠","isFav":true}]
parentId	string Only returned when requesting Get Node List and Search Nodes. Parent node ID. This attribute specifies the ID of the parent node for the current node. If the node does not have a parent node, then this attribute is not returned e.g. fodwrbgo8lDpbUjZzm

Currently, the AITable only supports the chat completions API and is only available to whitelisted users. Click here to apply

The data structure of the Member is as follows.

Properties	Type	Description	Example Value
unitId	string	Member's unitId	"T7fL3jV4KvX1cY2dGmS9sPqZzN6rWnB"
name	string	Member's name	"John"
avatar	string	The resource address for the member's avatar.	"https://s1.aitable.ai/public/2023/05/16/00a91wbb47fd0594fbc975d2d764a45q"
email	string	Member's email address	"test@aitable.ai"
mobile	object	Member's phone number	{"number": "12345678901","areaCode": "+86"}
status	integer	Member's status, whether joined space (1:joined, 0:not joined)	1
type	string	Member's type ("PrimaryAdmin" indicates the Primary admin of the space, "SubAdmin" indicates the sub-admin of the space, "Member" indicates the member in the space )	"Member"
teams	array of object	Teams to which the member belongs.	[{"unitId": "VS1SejiywaMWbiGMEHAohh62T9EPmmlh","name": "test","sequence": 1,"parentUnitId":"YN3YT97EPGL9ZA0loc9V2kNQnWb9ivKW"},...]
roles	array of object	Roles associated with the member.	[{"unitId": "sZ6gJ9L2HxP5XW1fRtNwE4zKqVcY7yM","name": "role A","sequence": 1},...]

The data structure of the Team is as follows.

Properties	Type	Description	Example Value
unitId	string	The unique ID of the team.	"C7dVpM3tBxL4jT6hRyK5WwQsZgX8fNv"
name	string	Team's name	"Team A"
sequence	integer	The sorting order of the team at the current hierarchy level. In the Contacts, teams are sorted in ascending order based on this sequence number. If there are duplicate sequence numbers within the same hierarchy level, the teams will be sorted in ascending order based on their creation time.	1
parentUnitId	string	The unitId of the parent team to which the team belongs.	"nL2vU7tZwKfR4aGxQyJjXq6YbP5mS9c"
roles	array of object	Roles associated with the team.	[{"unitId": "M3sJ6mL4fY9xN1yZpRtG7wKvX2TcVq","name": "role A","sequence": 1},..}]