Get File Category Field List

Get file category field list, including regular fields and tables (with table fields)

GET /api/app-api/sip/platform/v2/category/fields/list

Get File Category Field List

cURL

curl --request GET \
  --url https://docflow.textin.ai/api/app-api/sip/platform/v2/category/fields/list \
  --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/fields/list"

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/fields/list', 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/fields/list",
  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/fields/list"

	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/fields/list")
  .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/fields/list")

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

{
  "code": 200,
  "msg": "<string>",
  "result": {
    "fields": [
      {
        "name": "Invoice Code",
        "description": "Invoice code description",
        "prompt": "<string>",
        "use_prompt": true,
        "alias": [
          "Invoice No.",
          "Bill Number"
        ],
        "identity": "invoice_number",
        "multi_value": true,
        "duplicate_value_distinct": true,
        "transform_settings": {
          "datetime_settings": {
            "format": "yyyy-MM-dd"
          },
          "enumerate_settings": {
            "items": [
              "VAT Special Invoice",
              "VAT General Invoice",
              "Electronic Invoice"
            ]
          },
          "regex_settings": {
            "match": "^(\\d{4})-(\\d{2})-(\\d{2})$",
            "replace": "$1/$2/$3"
          },
          "mismatch_action": {
            "default_value": "N/A"
          }
        },
        "id": "1234567890",
        "extract_model": "Acgpt"
      }
    ],
    "tables": [
      {
        "id": "1234567890",
        "name": "Table 1",
        "description": "Table description",
        "prompt": "Extract item name, quantity and amount from each row",
        "collect_from_multi_table": true,
        "extract_model": "Acgpt",
        "fields": [
          {
            "name": "Invoice Code",
            "description": "Invoice code description",
            "prompt": "<string>",
            "use_prompt": true,
            "alias": [
              "Invoice No.",
              "Bill Number"
            ],
            "identity": "invoice_number",
            "multi_value": true,
            "duplicate_value_distinct": true,
            "transform_settings": {
              "datetime_settings": {
                "format": "yyyy-MM-dd"
              },
              "enumerate_settings": {
                "items": [
                  "VAT Special Invoice",
                  "VAT General Invoice",
                  "Electronic Invoice"
                ]
              },
              "regex_settings": {
                "match": "^(\\d{4})-(\\d{2})-(\\d{2})$",
                "replace": "$1/$2/$3"
              },
              "mismatch_action": {
                "default_value": "N/A"
              }
            },
            "id": "1234567890",
            "extract_model": "Acgpt"
          }
        ]
      }
    ]
  }
}

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"

Response

200 - application/json

Successfully retrieved file category field list

code · integer · required

Status code

Example:

200

msg · string · required

Status description

result · object

Show child attributes