Skip to main content
GET
/
projects
/
{project_name}
/
tables
/
{table_id}
/
run
/
{run_id}
Get AI Run Status & Result
curl --request GET \
  --url https://api.cloudsquid.io/api/projects/{project_name}/tables/{table_id}/run/{run_id} \
  --header 'X-API-Key: <api-key>'
{
  "data": {},
  "created_at": "2023-11-07T05:31:56Z",
  "row_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "reasoning": "<string>",
  "review": {
    "comment": "<string>",
    "reviewed_by": "<string>",
    "review_date": "2023-11-07T05:31:56Z",
    "approved": true
  },
  "input": {
    "data": {},
    "files": [
      {
        "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 3 of 3 in the async run pattern. Poll this endpoint using the run_id returned by Start AI Run until status is done or error.See the full async run pattern guide for a complete working example with a polling loop.

​
Run status values

StatusMeaning
pendingQueued, not yet started
runningAI is actively processing
doneComplete — data field is populated with extracted results
errorProcessing failed

​
Polling example

Python
import time, requests

while True:
    result = requests.get(
        "https://api.cloudsquid.io/api/projects/my-project/tables/TABLE_ID/run/RUN_ID",
        headers={"X-API-Key": "YOUR_API_KEY"}
    ).json()

    if result["status"] == "done":
        print(result["data"])
        break
    elif result["status"] == "error":
        raise RuntimeError("Extraction failed")

    time.sleep(3)
A poll interval of 2–5 seconds is appropriate for most workloads.

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

​
run_id
string<uuid>
required

the ID of the run

Response

Successfully got status of the file

​
data
object
required

Object with direct values for each key, allowing single values or arrays of values.

​
created_at
string<date-time>
required
​
row_id
string<uuid>
required
​
reasoning
string
​
review
object
​
status
enum<string>

status of the AI run

Available options:
running,
done,
error,
pending
​
input
object