Run all cells in a column of an AI table
curl --request POST \
--url https://cite.petal.org/api/ai/table/{ai_table_id}/column/{ai_column_id}/run \
--header 'Authorization: Bearer <token>'import requests
url = "https://cite.petal.org/api/ai/table/{ai_table_id}/column/{ai_column_id}/run"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://cite.petal.org/api/ai/table/{ai_table_id}/column/{ai_column_id}/run', 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://cite.petal.org/api/ai/table/{ai_table_id}/column/{ai_column_id}/run",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://cite.petal.org/api/ai/table/{ai_table_id}/column/{ai_column_id}/run"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://cite.petal.org/api/ai/table/{ai_table_id}/column/{ai_column_id}/run")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://cite.petal.org/api/ai/table/{ai_table_id}/column/{ai_column_id}/run")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body[
{
"ai_column_id": 123,
"document_id": 123,
"id": 123,
"meta": {},
"modified_at": "<string>",
"response": "<string>",
"task_id": "<string>",
"task_status": "<string>"
}
][
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"ctx": {}
}
]AI Table
Run AI on all cells in a row
Invokes the AI on all cells (Documents) within a column. If a cell does not already exist, a new one will be created. Existing cells’ responses will be overwritten
POST
/
api
/
ai
/
table
/
{ai_table_id}
/
column
/
{ai_column_id}
/
run
Run all cells in a column of an AI table
curl --request POST \
--url https://cite.petal.org/api/ai/table/{ai_table_id}/column/{ai_column_id}/run \
--header 'Authorization: Bearer <token>'import requests
url = "https://cite.petal.org/api/ai/table/{ai_table_id}/column/{ai_column_id}/run"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://cite.petal.org/api/ai/table/{ai_table_id}/column/{ai_column_id}/run', 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://cite.petal.org/api/ai/table/{ai_table_id}/column/{ai_column_id}/run",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://cite.petal.org/api/ai/table/{ai_table_id}/column/{ai_column_id}/run"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://cite.petal.org/api/ai/table/{ai_table_id}/column/{ai_column_id}/run")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://cite.petal.org/api/ai/table/{ai_table_id}/column/{ai_column_id}/run")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body[
{
"ai_column_id": 123,
"document_id": 123,
"id": 123,
"meta": {},
"modified_at": "<string>",
"response": "<string>",
"task_id": "<string>",
"task_status": "<string>"
}
][
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"ctx": {}
}
]Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The unique ID of the AI Table
The unique ID of the column
Response
OK
The unique ID of the column the cell belongs to
The unique ID of the Document associated with the cell
The unique ID of the cell
Metadata, for internal use
Modification time, by UTC
The AI's response to the user based on the column query of this cell, or a user-submitted response
Task ID for internal use
AI task status for this cell
