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
}
'
{
  "run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Documentation Index

Fetch the complete documentation index at: https://docs.cloudsquid.io/llms.txt

Use this file to discover all available pages before exploring further.

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