createTableRows

Inserts one or multiple new rows into the specified table.

POST /v1/tables/{table}/rows

cURL

cURL

curl --request POST \
  --url https://api.botpress.cloud/v1/tables/{table}/rows \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-bot-id: <x-bot-id>' \
  --data '
{
  "rows": [
    {}
  ],
  "waitComputed": true
}
'

import requests

url = "https://api.botpress.cloud/v1/tables/{table}/rows"

payload = {
    "rows": [{}],
    "waitComputed": True
}
headers = {
    "x-bot-id": "<x-bot-id>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-bot-id': '<x-bot-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({rows: [{}], waitComputed: true})
};

fetch('https://api.botpress.cloud/v1/tables/{table}/rows', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.botpress.cloud/v1/tables/{table}/rows",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'rows' => [
        [
                
        ]
    ],
    'waitComputed' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "x-bot-id: <x-bot-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.botpress.cloud/v1/tables/{table}/rows"

	payload := strings.NewReader("{\n  \"rows\": [\n    {}\n  ],\n  \"waitComputed\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-bot-id", "<x-bot-id>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.botpress.cloud/v1/tables/{table}/rows")
  .header("x-bot-id", "<x-bot-id>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"rows\": [\n    {}\n  ],\n  \"waitComputed\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.botpress.cloud/v1/tables/{table}/rows")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-bot-id"] = '<x-bot-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"rows\": [\n    {}\n  ],\n  \"waitComputed\": true\n}"

response = http.request(request)
puts response.read_body

200

{
  "rows": [
    {
      "id": 123,
      "computed": {},
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "stale": [
        "<string>"
      ],
      "similarity": 123
    }
  ],
  "warnings": [
    "<string>"
  ],
  "errors": [
    "<string>"
  ]
}

{
  "rows": [
    {
      "id": 123,
      "computed": {},
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "stale": [
        "<string>"
      ],
      "similarity": 123
    }
  ],
  "warnings": [
    "<string>"
  ],
  "errors": [
    "<string>"
  ]
}

Authorizations

Authorization · string · header · required

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

Headers

x-bot-id · string · required

Bot id

x-integration-id · string

Integration id

x-integration-alias · string

Integration alias

x-integration-name · string

Integration name

x-user-id · string

User Id

x-user-role · string

User Role

Path Parameters

table · string · required

The table's name or unique identifier for targeting specific table operations.

Body

application/json

A batch of new rows to insert into the table. Each row must adhere to the table’s schema. A maximum of 1000 rows can be inserted in a single request.

rows · object[] · required

Required array length: 1 - 1000 elements

waitComputed · boolean

Ensure computed columns are fully processed before returning the result. This is applicable only when the number of rows involved is fewer than 1.

Response

200

application/json

A summary of the insertion operation, including any warnings or errors encountered, and the inserted row data.

rows · object[] · required

Show child attributes

warnings · string[]

Alerts for minor issues that don't block the operation but suggest possible improvements.

errors · string[]

Critical issues in specific elements that prevent their successful processing, allowing partial operation success.