Create Table Sheet

Create a Table sheet by importing file or request log data.

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

Create Sheet

cURL

curl --request POST \
  --url https://api.promptlayer.com/api/public/v2/tables/{table_id}/sheets \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "source": {
    "type": "file",
    "file_name": "<string>",
    "file_content_base64": "<string>"
  },
  "title": "<string>",
  "index": 123,
  "operation_id": "<string>"
}
'

import requests

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

payload = {
    "source": {
        "type": "file",
        "file_name": "<string>",
        "file_content_base64": "<string>"
    },
    "title": "<string>",
    "index": 123,
    "operation_id": "<string>"
}
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({
    source: {type: 'file', file_name: '<string>', file_content_base64: '<string>'},
    title: '<string>',
    index: 123,
    operation_id: '<string>'
  })
};

fetch('https://api.promptlayer.com/api/public/v2/tables/{table_id}/sheets', 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",
  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([
    'source' => [
        'type' => 'file',
        'file_name' => '<string>',
        'file_content_base64' => '<string>'
    ],
    'title' => '<string>',
    'index' => 123,
    'operation_id' => '<string>'
  ]),
  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"

	payload := strings.NewReader("{\n  \"source\": {\n    \"type\": \"file\",\n    \"file_name\": \"<string>\",\n    \"file_content_base64\": \"<string>\"\n  },\n  \"title\": \"<string>\",\n  \"index\": 123,\n  \"operation_id\": \"<string>\"\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")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"source\": {\n    \"type\": \"file\",\n    \"file_name\": \"<string>\",\n    \"file_content_base64\": \"<string>\"\n  },\n  \"title\": \"<string>\",\n  \"index\": 123,\n  \"operation_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"source\": {\n    \"type\": \"file\",\n    \"file_name\": \"<string>\",\n    \"file_content_base64\": \"<string>\"\n  },\n  \"title\": \"<string>\",\n  \"index\": 123,\n  \"operation_id\": \"<string>\"\n}"

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

202

{
  "success": true,
  "message": "<string>",
  "operation_id": "<string>",
  "operation": {
    "operation_id": "<string>",
    "progress": 123,
    "message": "<string>",
    "rows_added": 123,
    "row_count": 123,
    "file_name": "<string>",
    "error_message": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "sheet": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "table_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "workspace_id": 123,
    "title": "<string>",
    "index": 123,
    "row_count": 123,
    "version_count": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

{
  "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>"
    }
  ]
}

Create a new sheet and start an asynchronous import job. The response returns immediately with 202, an operation_id, the import operation, and the newly created sheet.

File imports

Use source.type=file to import CSV or JSON content. Send the file content as base64 in file_content_base64; the decoded file can be up to 100MB. JSON input is converted to CSV before processing.

Request log imports

Use source.type=request_logs to import request history into a sheet. Provide either explicit request_log_ids or a request-log filter_group. You can also pass variables_to_parse, include_fields, and limit to control the imported columns and rows.

Operation tracking

Pass operation_id when you want a stable client-side identifier for polling and webhook correlation. If omitted, PromptLayer generates one.

Poll Get Table Sheet Import Operation until the operation reaches succeeded or failed.

Authorizations

X-API-KEY · string · header · required

Path Parameters

table_id · string<uuid> · required

Body

application/json

source · File source · object · required

Data source for the sheet.

File source

Request logs source

Show child attributes

title · string | null

Sheet title. Defaults to the source file name or 'Request Logs'.

index · integer | null

Display position within the table (0-based). Defaults to appending at the end.

operation_id · string | null

Optional idempotency key for the import operation.

Response

202

application/json

Import started. Poll the operation endpoint to track progress.

success · boolean

message · string

operation_id · string

operation · object

Status of an asynchronous sheet import operation.

Show child attributes

sheet · object

A sheet within a Table.

Show child attributes