Download Category Samples (ZIP)

Download multiple sample files of the specified category, packaged as a ZIP file. When sample_ids is not provided, all samples are downloaded.

POST /api/app-api/sip/platform/v2/category/sample/batch_download

Download Category Samples (ZIP)

cURL

curl --request POST \
  --url https://docflow.textin.ai/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
  ]
}
'

import requests

url = "https://docflow.textin.ai/api/app-api/sip/platform/v2/category/sample/batch_download"

payload = {
    "workspace_id": "1234567890",
    "category_id": "1234567890",
    "sample_ids": ["1234567890", 987654321]
}
headers = {
    "x-ti-app-id": "<api-key>",
    "x-ti-secret-code": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-ti-app-id': '<api-key>',
    'x-ti-secret-code': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    workspace_id: '1234567890',
    category_id: '1234567890',
    sample_ids: ['1234567890', 987654321]
  })
};

fetch('https://docflow.textin.ai/api/app-api/sip/platform/v2/category/sample/batch_download', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://docflow.textin.ai/api/app-api/sip/platform/v2/category/sample/batch_download",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'workspace_id' => '1234567890',
    'category_id' => '1234567890',
    'sample_ids' => [
        '1234567890',
        987654321
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-ti-app-id: <api-key>",
    "x-ti-secret-code: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://docflow.textin.ai/api/app-api/sip/platform/v2/category/sample/batch_download"

	payload := strings.NewReader("{\n  \"workspace_id\": \"1234567890\",\n  \"category_id\": \"1234567890\",\n  \"sample_ids\": [\n    \"1234567890\",\n    987654321\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-ti-app-id", "<api-key>")
	req.Header.Add("x-ti-secret-code", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://docflow.textin.ai/api/app-api/sip/platform/v2/category/sample/batch_download")
  .header("x-ti-app-id", "<api-key>")
  .header("x-ti-secret-code", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"workspace_id\": \"1234567890\",\n  \"category_id\": \"1234567890\",\n  \"sample_ids\": [\n    \"1234567890\",\n    987654321\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://docflow.textin.ai/api/app-api/sip/platform/v2/category/sample/batch_download")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-ti-app-id"] = '<api-key>'
request["x-ti-secret-code"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"workspace_id\": \"1234567890\",\n  \"category_id\": \"1234567890\",\n  \"sample_ids\": [\n    \"1234567890\",\n    987654321\n  ]\n}"

response = http.request(request)
puts response.read_body

200

"<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.