Skip to main content
POST
/
projects
/
{project_name}
/
tables
/
{table_id}
/
run
Request starts the analyze process for a table
curl --request POST \
  --url https://api.cloudsquid.io/api/projects/{project_name}/tables/{table_id}/run \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "row_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "zero_retention": true
}
'
import requests

url = "https://api.cloudsquid.io/api/projects/{project_name}/tables/{table_id}/run"

payload = {
    "row_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "zero_retention": True
}
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({row_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', zero_retention: true})
};

fetch('https://api.cloudsquid.io/api/projects/{project_name}/tables/{table_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://api.cloudsquid.io/api/projects/{project_name}/tables/{table_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_POSTFIELDS => json_encode([
    'row_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'zero_retention' => true
  ]),
  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.cloudsquid.io/api/projects/{project_name}/tables/{table_id}/run"

	payload := strings.NewReader("{\n  \"row_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"zero_retention\": true\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.cloudsquid.io/api/projects/{project_name}/tables/{table_id}/run")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"row_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"zero_retention\": true\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.cloudsquid.io/api/projects/{project_name}/tables/{table_id}/run")

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  \"row_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"zero_retention\": true\n}"

response = http.request(request)
puts response.read_body
{
  "run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
{
  "errorMessage": "<string>"
}
{
  "errorMessage": "<string>"
}
This is step 2 of 3 in the async run pattern. You need a row_id from uploading a file first. After starting the run, poll for results using the returned run_id.See the full async run pattern guide for a complete working example.

​
What this does

Enqueues an AI job for the given row and returns immediately with a run_id. Processing happens asynchronously — the run status transitions from pending → running → done (or error).

​
Zero retention mode

Pass "zero_retention": true to run extraction without persisting intermediate results. Useful for privacy-sensitive workloads where you want the final output but not intermediate artifacts stored on Cloudsquid infrastructure.

​
Example

Python
import requests

response = requests.post(
    "https://api.cloudsquid.io/api/projects/my-project/tables/TABLE_ID/run",
    headers={"X-API-Key": "YOUR_API_KEY"},
    json={"row_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}
)
run_id = response.json()["run_id"]
Pass run_id to GET /run/{run_id} to check status and retrieve results.

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
project_name
string
required

The name of the project

​
table_id
string<uuid>
required

The id of the table

Body

application/json
​
row_id
string<uuid>
required

Row to start run

​
zero_retention
boolean

indicates if the extraction is run in zero-retention mode. Default false

Response

Analysis started successfully

​
run_id
string<uuid>
required

The id of the run