Skip to main content
POST
/
api
/
app-api
/
sip
/
platform
/
v2
/
category
/
sample
/
batch_download
Download Category Samples (ZIP)
curl --request POST \
  --url https://docflow.textin.com/api/app-api/sip/platform/v2/category/sample/batch_download \
  --header 'Content-Type: application/json' \
  --header 'x-ti-app-id: <api-key>' \
  --header 'x-ti-secret-code: <api-key>' \
  --data '
{
  "workspace_id": "1234567890",
  "category_id": "1234567890",
  "sample_ids": [
    "1234567890",
    987654321
  ]
}
'
"<string>"

Authorizations

​
x-ti-app-id
string
header
required
​
x-ti-secret-code
string
header
required

Body

application/json
​
workspace_id
string
required

Workspace ID

Example:

"1234567890"

​
category_id
string
required

File category ID

Example:

"1234567890"

​
sample_ids
string[]

List of sample IDs to download. When not provided, all samples of this category are downloaded.

Example:
["1234567890", 987654321]

Response

200 - application/zip

Successfully downloaded sample ZIP file

The response is of type file.