Import File

Start an asynchronous CSV import into an existing Table sheet. 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}/imports/file

Import File Into Table Sheet

cURL

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

import requests

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

payload = {
    "file_name": "<string>",
    "file_content_base64": "<string>",
    "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({
    file_name: '<string>',
    file_content_base64: '<string>',
    operation_id: '<string>'
  })
};

fetch('https://api.promptlayer.com/api/public/v2/tables/{table_id}/sheets/{sheet_id}/imports/file', 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}/imports/file",
  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([
    'file_name' => '<string>',
    'file_content_base64' => '<string>',
    '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/{sheet_id}/imports/file"

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

require 'uri'
require 'net/http'

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

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  \"file_name\": \"<string>\",\n  \"file_content_base64\": \"<string>\",\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"
  },
  "status_url": "<string>"
}

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

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

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

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

Start an asynchronous CSV import into an existing sheet.

Send file_name ending in .csv and file_content_base64 containing the base64-encoded CSV content.

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

The response returns an operation_id and status_url for polling with Get Sheet Import Operation.

Authorizations

X-API-KEY · string · header · required

Headers

X-API-KEY · string · required

Your PromptLayer API key. The key's workspace scopes table resources for this request.

Path Parameters

table_id · string<uuid> · required

Table ID.

sheet_id · string<uuid> · required

Table sheet ID.

Body

application/json

file_name · string · required

CSV file name. Must end with .csv.

Required string length: 1 - 255

file_content_base64 · string · required

Base64-encoded CSV file content.

Minimum string length: 1

operation_id · string | null

Optional client-provided operation ID. A UUID is generated when omitted.

Response

202

application/json

File import queued.

success · boolean · required

message · string · required

operation_id · string · required

operation · object · required

Status of an asynchronous sheet import operation.

Show child attributes

status_url · string · required