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 '
{
  "file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "zero_retention": true,
  "pipeline": "cloudsquid-flash"
}
'
{
  "run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

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
​
file_id
string<uuid>
required

File to start run

​
zero_retention
boolean
required

indicates if the extraction is run in zero-retention mode

​
pipeline
enum<string>

Optional. Defaults to cloudsquid-flash-v3 if not provided.

Available options:
cloudsquid-flash,
cloudsquid-flash-v3,
cloudsquid-pro-v2,
cloudsquid-pro-v3

Response

Analysis started successfully

​
run_id
string<uuid>
required

The id of the run