Build a table from a file attached to an AI Assistant message

curl --request POST \
  --url https://api.getoneprofile.ai/chat-attachments/{attachment_id}/import/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "<string>",
  "header_row": 0,
  "row_ranges": [
    {
      "first": 2,
      "last": 2
    }
  ]
}
'

import requests

url = "https://api.getoneprofile.ai/chat-attachments/{attachment_id}/import/"

payload = {
    "name": "<string>",
    "header_row": 0,
    "row_ranges": [
        {
            "first": 2,
            "last": 2
        }
    ]
}
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({name: '<string>', header_row: 0, row_ranges: [{first: 2, last: 2}]})
};

fetch('https://api.getoneprofile.ai/chat-attachments/{attachment_id}/import/', 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.getoneprofile.ai/chat-attachments/{attachment_id}/import/",
  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([
    'name' => '<string>',
    'header_row' => 0,
    'row_ranges' => [
        [
                'first' => 2,
                'last' => 2
        ]
    ]
  ]),
  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.getoneprofile.ai/chat-attachments/{attachment_id}/import/"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"header_row\": 0,\n  \"row_ranges\": [\n    {\n      \"first\": 2,\n      \"last\": 2\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.getoneprofile.ai/chat-attachments/{attachment_id}/import/")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"header_row\": 0,\n  \"row_ranges\": [\n    {\n      \"first\": 2,\n      \"last\": 2\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getoneprofile.ai/chat-attachments/{attachment_id}/import/")

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  \"name\": \"<string>\",\n  \"header_row\": 0,\n  \"row_ranges\": [\n    {\n      \"first\": 2,\n      \"last\": 2\n    }\n  ]\n}"

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

{
  "column_count": 123,
  "file_row_count": 123,
  "import_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "limited_by": "plan",
  "row_count": 123,
  "row_limit": 123,
  "table_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "table_name": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

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

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

assistant

Build a table from a file attached to an AI Assistant message

Create a table from a file attached to a message, every column of the file becoming a column of the table with a type read off its values, and start adding the file’s rows to it in the background. Takes any size of file the plan’s row limit allows, so it is the way to turn a whole lead list into a table. A PDF becomes the table its pages hold, its columns named as the PDF names them. When the file’s first row is a title, header_row names the row that holds the column names, and row_ranges picks rows numbered as a page of the file’s rows shows them. The table exists when this returns; poll the import job to follow the rows arriving. Only your own files.

POST

chat-attachments

{attachment_id}

import

Build a table from a file attached to an AI Assistant message

curl --request POST \
  --url https://api.getoneprofile.ai/chat-attachments/{attachment_id}/import/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "<string>",
  "header_row": 0,
  "row_ranges": [
    {
      "first": 2,
      "last": 2
    }
  ]
}
'

import requests

url = "https://api.getoneprofile.ai/chat-attachments/{attachment_id}/import/"

payload = {
    "name": "<string>",
    "header_row": 0,
    "row_ranges": [
        {
            "first": 2,
            "last": 2
        }
    ]
}
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({name: '<string>', header_row: 0, row_ranges: [{first: 2, last: 2}]})
};

fetch('https://api.getoneprofile.ai/chat-attachments/{attachment_id}/import/', 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.getoneprofile.ai/chat-attachments/{attachment_id}/import/",
  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([
    'name' => '<string>',
    'header_row' => 0,
    'row_ranges' => [
        [
                'first' => 2,
                'last' => 2
        ]
    ]
  ]),
  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.getoneprofile.ai/chat-attachments/{attachment_id}/import/"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"header_row\": 0,\n  \"row_ranges\": [\n    {\n      \"first\": 2,\n      \"last\": 2\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.getoneprofile.ai/chat-attachments/{attachment_id}/import/")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"header_row\": 0,\n  \"row_ranges\": [\n    {\n      \"first\": 2,\n      \"last\": 2\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getoneprofile.ai/chat-attachments/{attachment_id}/import/")

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  \"name\": \"<string>\",\n  \"header_row\": 0,\n  \"row_ranges\": [\n    {\n      \"first\": 2,\n      \"last\": 2\n    }\n  ]\n}"

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

{
  "column_count": 123,
  "file_row_count": 123,
  "import_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "limited_by": "plan",
  "row_count": 123,
  "row_limit": 123,
  "table_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "table_name": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

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

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

Authorizations

X-API-Key

string

header

required

Path Parameters

attachment_id

string<uuid>

required

Body

application/json

Build a table out of an attached file.

name

string

required

What to call the table. Unique in the workspace.

Required string length: 1 - 255

header_row

integer

default:0

For a file whose first row is a title: the row that holds the column names, numbered as a page of the file's rows numbers them (1 is the first row under the title). The table's columns are named from it and only the rows below it are added. 0 keeps the first row as the header.

Required range: x >= 0

row_ranges

ImportRowRangeSchema · object[] | null

Only these rows, the way a print dialog picks pages, numbered as a page of the file's rows numbers them and as header_row is: 1 is the row at offset 0, the first under the file's first row, and every row holding any text counts, a row of placeholders like N/A included. So with header_row 2 the rows under the column names start at 3. A row the table gets no value from (only placeholders, or the column names and the rows above them) is left out. At most 100 ranges once merged. Omit for every row.

Required array length: 1 - 1000 elements

Show child attributes

Response

Successful Response

The table an attached file is becoming.

The table exists when this returns; its rows are still arriving, loaded in the background from the file's own rows. row_count is how many will land, which is the file's count clamped to the row ceiling, and the file's own count stands beside it so a caller can say when the two differ rather than pass the smaller number off as the whole file.

column_count

integer

required

file_row_count

integer

required

Rows in the file, as its attachment card counts them, less the header row named and the rows above it.

import_id

string<uuid>

required

The import job loading the rows, for polling.

limited_by

enum<string> | null

required

Whose ceiling it was: the plan's, which a bigger plan raises, or the deployment's, which none does. Null when nothing was cut.

Available options:

plan,

deployment

row_count

integer

required

Rows that will be added: the rows chosen, or the file's from the top.

row_limit

integer | null

required

The ceiling that cut the file short, or null when every row is being added.

table_id

string<uuid>

required

table_name

string

required

API reference

Endpoints

Build a table from a file attached to an AI Assistant message

Authorizations

Path Parameters

Body

Response