Skip to main content
POST
/
extract
/
{source_id}
Synchronous extraction for a file end to end
curl --request POST \
  --url https://api.cloudsquid.io/api/extract/{source_id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "document": {
    "mimetype": "application/pdf",
    "filename": "<string>",
    "file_type": "uri",
    "file": "<string>",
    "zero_retention_mode": true
  },
  "pipeline": "cloudsquid-flash"
}
'
{
  "result": {}
}

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
source_id
string<uuid>
required

the ID of the extraction source

Body

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

Response

Successfully extracted file

​
result
object

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