Add Single File Category Table

Add a new table under the specified file category

⚠️ This endpoint is still available but will no longer be maintained. Please use Add File Category Tables instead.

POST /api/app-api/sip/platform/v2/category/tables/add

Add Single File Category Table

cURL

curl --request POST \
  --url https://docflow.textin.ai/api/app-api/sip/platform/v2/category/tables/add \
  --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",
  "name": "Table 1",
  "prompt": "Extract item name, quantity and amount from each row",
  "collect_from_multi_table": true,
  "extract_model": "Acgpt",
  "with_detail": true
}
'

import requests

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

payload = {
    "workspace_id": "1234567890",
    "category_id": "1234567890",
    "name": "Table 1",
    "prompt": "Extract item name, quantity and amount from each row",
    "collect_from_multi_table": True,
    "extract_model": "Acgpt",
    "with_detail": True
}
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',
    name: 'Table 1',
    prompt: 'Extract item name, quantity and amount from each row',
    collect_from_multi_table: true,
    extract_model: 'Acgpt',
    with_detail: true
  })
};

fetch('https://docflow.textin.ai/api/app-api/sip/platform/v2/category/tables/add', 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/tables/add",
  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',
    'name' => 'Table 1',
    'prompt' => 'Extract item name, quantity and amount from each row',
    'collect_from_multi_table' => true,
    'extract_model' => 'Acgpt',
    'with_detail' => true
  ]),
  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/tables/add"

	payload := strings.NewReader("{\n  \"workspace_id\": \"1234567890\",\n  \"category_id\": \"1234567890\",\n  \"name\": \"Table 1\",\n  \"prompt\": \"Extract item name, quantity and amount from each row\",\n  \"collect_from_multi_table\": true,\n  \"extract_model\": \"Acgpt\",\n  \"with_detail\": true\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/tables/add")
  .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  \"name\": \"Table 1\",\n  \"prompt\": \"Extract item name, quantity and amount from each row\",\n  \"collect_from_multi_table\": true,\n  \"extract_model\": \"Acgpt\",\n  \"with_detail\": true\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"name\": \"Table 1\",\n  \"prompt\": \"Extract item name, quantity and amount from each row\",\n  \"collect_from_multi_table\": true,\n  \"extract_model\": \"Acgpt\",\n  \"with_detail\": true\n}"

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

200

{
  "code": 200,
  "msg": "<string>",
  "result": {
    "table_id": "1234567890",
    "name": "<string>",
    "description": "<string>",
    "prompt": "<string>",
    "collect_from_multi_table": true,
    "extract_model": "<string>",
    "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

Body

application/json

workspace_id · string · required

Workspace ID

Example:

"1234567890"

category_id · string · required

File category ID

Example:

"1234567890"

name · string · required

Table name

Maximum string length: 50

Example:

"Table 1"

prompt · string

Table semantic extraction prompt

Maximum string length: 200

Example:

"Extract item name, quantity and amount from each row"

collect_from_multi_table · boolean

Merge multiple tables

Example:

true

extract_model · enum<string>

Table-level extraction model

• Auto: Automatically matches the extraction model
• Acgpt: Fast speed with stable extraction results
• Acgpt-VL: VLM, suitable for simple extraction (≤10 pages)
• DF-M1: Suitable for complex document understanding

Available options: Auto, Acgpt, Acgpt-VL, DF-M1

Example:

"Acgpt"

with_detail · boolean

Whether to return full details. When true, the response includes complete table info (with field list). When not set or false, only table_id is returned.

Response

200 - application/json

Successfully added file category table

code · integer · required

Status code

Example:

200

msg · string · required

Status description

result · object

Show child attributes