Create a row in a database table | Baserow Representative API Octri Preview

7 parameters · 17 body fields

table_idintegerrequired

The unique identifier of the table in which to create the row.

beforeintegeroptional

The ID of an existing row to position the new row before.

send_webhook_eventsbooleanoptional

Whether to trigger webhooks after the operation. Accepts `y`, `yes`, `true`, `t`, `on`, `1`, or an empty value to enable; defaults to `true` when omitted.

user_field_namesbooleanoptional

When enabled with a truthy value such as `y`, `yes`, `true`, `t`, `on`, `1`, or an empty value, uses user-defined field names instead of internal names such as `field_123`.

viewintegeroptional

The ID of the view in which to create the row; providing it can affect permission checks and default values.

ClientSessionIdstringoptional

An optional UUID identifying the client session, which can be used with undo or redo operations to reverse or repeat this action.

ClientUndoRedoActionGroupIdstringoptional

An optional UUID grouping this action with other actions for undo or redo.

Values for the table fields to set on the new row. All fields are optional; omitted fields receive null, false, or a configured default.

field_1stringoptional

This field represents the `text` field. The number in field_1 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: `y`, `yes`, `true`, `t`, `on`, `1`, or empty, then the key will instead be the actual name of the field.

field_13numberoptional

This field represents the `duration` field. The number in field_13 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: `y`, `yes`, `true`, `t`, `on`, `1`, or empty, then the key will instead be the actual name of the field. The provided value can be a string in one of the available formats or a number representing the duration in seconds. In any case, the value will be rounded to match the field's duration format.

field_14array<integer>optional

This field represents the `link_row` field. The number in field_14 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: `y`, `yes`, `true`, `t`, `on`, `1`, or empty, then the key will instead be the actual name of the field. This field accepts an `array` containing the ids or the names of the related rows. A name is the value of the primary key of the related row. This field also accepts a string with names separated by a comma or an array of row names. You can also provide a unique row Id.The response contains a list of objects containing the `id` and the primary field's `value` as a string for display purposes.

field_15arrayoptional

This field represents the `file` field. The number in field_15 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: `y`, `yes`, `true`, `t`, `on`, `1`, or empty, then the key will instead be the actual name of the field. This field accepts an `array` containing objects with the name of the file. The response contains an `array` of more detailed objects related to the files.

field_16integeroptional

Accepts one of the following option ids as integer value This field accepts an `integer` representing the chosen select option id related to the field. Available ids can be found when getting or listing the field. The response represents chosen field, but also the value and color is exposed..

field_17array<integer>optional

This field represents the `multiple_select` field. The number in field_17 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: `y`, `yes`, `true`, `t`, `on`, `1`, or empty, then the key will instead be the actual name of the field. This field accepts a list of `integer` each of which representing the chosen select option id related to the field. Available ids can be foundwhen getting or listing the field. You can also send a list of option names in which case the option are searched by name. The first one that matches is used. This field also accepts a string with names separated by a comma or an array of file names. The response represents chosen field, but also the value and color is exposed.

field_18stringoptional

This field represents the `phone_number` field. The number in field_18 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: `y`, `yes`, `true`, `t`, `on`, `1`, or empty, then the key will instead be the actual name of the field.

field_2stringoptional

This field represents the `long_text` field. The number in field_2 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: `y`, `yes`, `true`, `t`, `on`, `1`, or empty, then the key will instead be the actual name of the field.

field_23array<integer>optional

This field represents the `multiple_collaborators` field. The number in field_23 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: `y`, `yes`, `true`, `t`, `on`, `1`, or empty, then the key will instead be the actual name of the field. This field accepts a list of objects representing the chosen collaborators through the object's `id` property. The id is Baserow user id. The response objects also contains the collaborator name directly along with its id.

field_26stringoptional

This field represents the `password` field. The number in field_26 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: `y`, `yes`, `true`, `t`, `on`, `1`, or empty, then the key will instead be the actual name of the field. Allows setting a write only password value. Providing a string will set the password, `null` will unset it, `true` will be ignored. The response will respond with `true` is a password is set, but will never expose the password itself.

field_29stringoptional

This field represents the `ai` field. The number in field_29 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: `y`, `yes`, `true`, `t`, `on`, `1`, or empty, then the key will instead be the actual name of the field. Holds a value that is generated by a generative AI model using a dynamic prompt.

field_3stringoptional

This field represents the `url` field. The number in field_3 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: `y`, `yes`, `true`, `t`, `on`, `1`, or empty, then the key will instead be the actual name of the field.

field_4stringoptional

This field represents the `email` field. The number in field_4 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: `y`, `yes`, `true`, `t`, `on`, `1`, or empty, then the key will instead be the actual name of the field.

field_5stringoptional

This field represents the `number` field. The number in field_5 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: `y`, `yes`, `true`, `t`, `on`, `1`, or empty, then the key will instead be the actual name of the field.

field_6integeroptional

This field represents the `rating` field. The number in field_6 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: `y`, `yes`, `true`, `t`, `on`, `1`, or empty, then the key will instead be the actual name of the field.

Default:0

field_7booleanoptional

This field represents the `boolean` field. The number in field_7 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: `y`, `yes`, `true`, `t`, `on`, `1`, or empty, then the key will instead be the actual name of the field.

Default:false

field_8stringoptional

This field represents the `date` field. The number in field_8 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: `y`, `yes`, `true`, `t`, `on`, `1`, or empty, then the key will instead be the actual name of the field.

4 status codes

200Returns the created row object, including its row ID and field values.

field_1stringoptional

field_10objectoptional

This field represents the `last_modified_by` field. The number in field_10 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: `y`, `yes`, `true`, `t`, `on`, `1`, or empty, then the key will instead be the actual name of the field.

field_11stringoptional

This field represents the `created_on` field. The number in field_11 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: `y`, `yes`, `true`, `t`, `on`, `1`, or empty, then the key will instead be the actual name of the field.

field_12objectoptional

This field represents the `created_by` field. The number in field_12 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: `y`, `yes`, `true`, `t`, `on`, `1`, or empty, then the key will instead be the actual name of the field.

field_13numberoptional

field_14array<object>optional

field_15array<object>optional

field_16objectoptional

This field represents the `single_select` field. The number in field_16 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: `y`, `yes`, `true`, `t`, `on`, `1`, or empty, then the key will instead be the actual name of the field. This field accepts an `integer` representing the chosen select option id related to the field. Available ids can be found when getting or listing the field. The response represents chosen field, but also the value and color is exposed.

field_17array<object>optional

field_18stringoptional

field_19stringoptional

This field represents the `formula` field. The number in field_19 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: `y`, `yes`, `true`, `t`, `on`, `1`, or empty, then the key will instead be the actual name of the field.

field_2stringoptional

field_20stringoptional

This field represents the `count` field. The number in field_20 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: `y`, `yes`, `true`, `t`, `on`, `1`, or empty, then the key will instead be the actual name of the field.

field_21stringoptional

This field represents the `rollup` field. The number in field_21 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: `y`, `yes`, `true`, `t`, `on`, `1`, or empty, then the key will instead be the actual name of the field.

field_22stringoptional

This field represents the `lookup` field. The number in field_22 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: `y`, `yes`, `true`, `t`, `on`, `1`, or empty, then the key will instead be the actual name of the field.

field_23array<object>optional

field_24stringoptional

This field represents the `uuid` field. The number in field_24 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: `y`, `yes`, `true`, `t`, `on`, `1`, or empty, then the key will instead be the actual name of the field. Contains a unique and persistent UUID for every row.

field_25integeroptional

This field represents the `autonumber` field. The number in field_25 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: `y`, `yes`, `true`, `t`, `on`, `1`, or empty, then the key will instead be the actual name of the field. Contains a unique and persistent incremental integer number for every row.

field_26booleanoptional

field_27stringrequired

This field represents the `form_view_edit_row` field. The number in field_27 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: `y`, `yes`, `true`, `t`, `on`, `1`, or empty, then the key will instead be the actual name of the field.

field_28stringoptional

This field represents the `button` field. The number in field_28 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: `y`, `yes`, `true`, `t`, `on`, `1`, or empty, then the key will instead be the actual name of the field.

field_29stringoptional

field_3stringoptional

field_4stringoptional

field_5stringoptional

field_6integeroptional

Default:0

field_7booleanoptional

Default:false

field_8stringoptional

field_9stringoptional

This field represents the `last_modified` field. The number in field_9 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: `y`, `yes`, `true`, `t`, `on`, `1`, or empty, then the key will instead be the actual name of the field.

idintegerrequired

The unique identifier of the row in the table.

metadataobjectoptional

Additional metadata for the row, if `include=metadata' is provided as query parameter.

orderstringoptional

Indicates the position of the row, lowest first and highest last.

400Returned when a field value fails validation or a referenced file cannot be found.

detailstringoptional

Human readable details about what went wrong.

errorstringoptional

Machine readable error indicating what went wrong.

Allowed:ERROR_USER_NOT_IN_GROUPERROR_REQUEST_BODY_VALIDATIONERROR_REQUEST_BODY_VALIDATIONERROR_RICH_TEXT_IMAGE_LIMIT_EXCEEDEDERROR_USER_FILE_DOES_NOT_EXIST

401Returned when the authenticated user does not have permission to access the table.

detailstringoptional

Human readable details about what went wrong.

errorstringoptional

Machine readable error indicating what went wrong.

Allowed:ERROR_NO_PERMISSION_TO_TABLE

404Returned when the table, row, or view identified by the request does not exist.

detailstringoptional

Human readable details about what went wrong.

errorstringoptional

Machine readable error indicating what went wrong.

Allowed:ERROR_TABLE_DOES_NOT_EXISTERROR_ROW_DOES_NOT_EXISTERROR_VIEW_DOES_NOT_EXIST

Error handling

A 400 is returned when a field value fails validation. A 401 is returned when the authenticated user does not have permission to access the table. A 404 is returned when the table or specified view does not exist. The table_id path parameter must identify the table to add the row to.

import { BaserowAPIUnofficialOctriRepresentativePreview } from "baserow-full-api-octri-preview-sdk";

// Local synthetic mock only; never run this example against production.
const client = new BaserowAPIUnofficialOctriRepresentativePreview({
  baseUrl: "http://127.0.0.1:18089",
  auth: { databaseToken: "synthetic-token" },
});
const row = await client.databaseTableRows.create({ tableId: 1847, field1: "Synthetic" });
console.log(row.id);

{
  "field_1": "example_value",
  "field_10": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Example Name"
  },
  "field_11": "2026-01-15T09:00:00Z",
  "field_12": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Example Name"
  },
  "field_13": 1,
  "field_14": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "order": "example_value",
      "value": "example_value"
    }
  ],
  "field_15": [
    {
      "image_height": "https://example.com/image.jpg",
      "image_width": "https://example.com/image.jpg",
      "is_image": true,
      "mime_type": "example_value",
      "name": "Example Name",
      "size": 1,
      "uploaded_at": "2026-01-15T09:00:00Z",
      "url": "https://example.com",
      "visible_name": "Example Name"
    }
  ],
  "field_16": {
    "color": "#6366f1",
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "value": "example_value"
  },
  "field_17": [
    {
      "color": "#6366f1",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "value": "example_value"
    }
  ],
  "field_18": "example_value",
  "field_19": "example_value",
  "field_2": "example_value",
  "field_20": "example_value",
  "field_21": "example_value",
  "field_22": "example_value",
  "field_23": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Example Name"
    }
  ],
  "field_24": "550e8400-e29b-41d4-a716-446655440000",
  "field_25": 1,
  "field_26": true,
  "field_27": "example_value",
  "field_28": "example_value",
  "field_29": "example_value",
  "field_3": "example_value",
  "field_4": "example_value",
  "field_5": "example_value",
  "field_6": 0,
  "field_7": false,
  "field_8": "2026-01-15",
  "field_9": "2026-01-15T09:00:00Z",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "metadata": {
    "row_comment_count": 42,
    "row_comments_notification_mode": "all"
  },
  "order": "example_value"
}

Request

Response

Errors