Add Rows

Append one or more rows to a sheet. Text column values can be set immediately; non-text column cells are created with stale status and must be triggered via a recalculation. Requests are scoped to the workspace associated with the API key; table, sheet, column, cell, operation, and version IDs must belong to that workspace.

POST /api/public/v2/tables/{table_id}/sheets/{sheet_id}/rows

Add Rows

cURL

curl --request POST \
  --url https://api.promptlayer.com/api/public/v2/tables/{table_id}/sheets/{sheet_id}/rows \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "count": 1,
  "values": [
    {}
  ]
}
'

import requests

url = "https://api.promptlayer.com/api/public/v2/tables/{table_id}/sheets/{sheet_id}/rows"

payload = {
    "count": 1,
    "values": [{}]
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({count: 1, values: [{}]})
};

fetch('https://api.promptlayer.com/api/public/v2/tables/{table_id}/sheets/{sheet_id}/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.promptlayer.com/api/public/v2/tables/{table_id}/sheets/{sheet_id}/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([
    'count' => 1,
    'values' => [
        [
                
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$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.promptlayer.com/api/public/v2/tables/{table_id}/sheets/{sheet_id}/rows"

	payload := strings.NewReader("{\n  \"count\": 1,\n  \"values\": [\n    {}\n  ]\n}")

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

	req.Header.Add("X-API-KEY", "<api-key>")
	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.promptlayer.com/api/public/v2/tables/{table_id}/sheets/{sheet_id}/rows")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"count\": 1,\n  \"values\": [\n    {}\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.promptlayer.com/api/public/v2/tables/{table_id}/sheets/{sheet_id}/rows")

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

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"count\": 1,\n  \"values\": [\n    {}\n  ]\n}"

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

201

{
  "success": true,
  "rows_created": 123,
  "start_row_index": 123,
  "row_indices": [
    123
  ],
  "rows": [
    {
      "row_index": 123,
      "cells": {}
    }
  ],
  "cell_count": 123,
  "row_count": 123,
  "version": 123
}

{
  "success": false,
  "message": "<string>",
  "error": "<string>"
}

{
  "success": false,
  "message": "<string>",
  "error": "<string>"
}

{
  "success": false,
  "message": "<string>",
  "error": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Append one or more rows (up to 100 at a time) to a sheet.

Text column values can be set immediately via the values array. Non-text column cells are created with stale status — trigger a recalculation to compute them.

Adding rows creates a new sheet version. The response returns version, the current sheet version count after the rows are appended.

Authorizations

X-API-KEY · string · header · required

Path Parameters

table_id · string<uuid> · required

sheet_id · string<uuid> · required

Body

application/json

count · integer · default: 1

Number of rows to append (1–100).

Required range: 1 <= x <= 100

values · object[] | null

Per-row initial values for text columns. Each element is a map of column_id → value.

Response

201

application/json

Rows added

success · boolean

rows_created · integer

start_row_index · integer

row_indices · integer[]

rows · object[]

Show child attributes

cell_count · integer

row_count · integer

version · integer

Current sheet version_count for this response. It matches the sheet's version_count after any committed changes.