Download Single Category Sample

Download the specified category sample file

⚠️ This endpoint is still available but will no longer be maintained. Please use Download Category Samples (ZIP) instead.

GET /api/app-api/sip/platform/v2/category/sample/download

Download Single Category Sample

cURL

curl --request GET \
  --url https://docflow.textin.ai/api/app-api/sip/platform/v2/category/sample/download \
  --header 'x-ti-app-id: <api-key>' \
  --header 'x-ti-secret-code: <api-key>'

import requests

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

headers = {
    "x-ti-app-id": "<api-key>",
    "x-ti-secret-code": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'x-ti-app-id': '<api-key>', 'x-ti-secret-code': '<api-key>'}
};

fetch('https://docflow.textin.ai/api/app-api/sip/platform/v2/category/sample/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/download",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-ti-app-id", "<api-key>")
	req.Header.Add("x-ti-secret-code", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://docflow.textin.ai/api/app-api/sip/platform/v2/category/sample/download")
  .header("x-ti-app-id", "<api-key>")
  .header("x-ti-secret-code", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["x-ti-app-id"] = '<api-key>'
request["x-ti-secret-code"] = '<api-key>'

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

Query Parameters

workspace_id · string · required

Workspace ID

Example:

"1234567890"

category_id · string · required

File category ID

Example:

"1234567890"

sample_id · string · required

Sample ID

Example:

"1234567890"

Response

200 - application/octet-stream

Successfully downloaded sample file

The response is of type file.