Skip to main content
POST
/
datasources
/
{source_id}
/
run
Start an extraction run for a file
curl --request POST \
  --url https://api.cloudsquid.io/api/datasources/{source_id}/run \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "pipeline": "cloudsquid-flash",
  "file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "zero_retention": true
}
'
{
  "run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
source_id
string<uuid>
required

the ID of the datasource

Body

application/json
​
pipeline
enum<string>
required
Available options:
cloudsquid-flash,
cloudsquid-pro-v2
​
file_id
string<uuid>
required

File to start extraction

​
zero_retention
boolean
required

indicates if the extraction is run in zero-retention mode

Response

Extraction started successfully

​
run_id
string<uuid>
required

The id of the run