ファイルカテゴリを更新
curl --request POST \
--url https://docflow.textin.ai/api/app-api/sip/platform/v2/category/update \
--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": "インボイス",
"category_prompt": "VAT インボイス。インボイスコード、インボイス番号などのフィールドを含みます。",
"extract_model": "Acgpt",
"with_detail": true
}
'import requests
url = "https://docflow.textin.ai/api/app-api/sip/platform/v2/category/update"
payload = {
"workspace_id": "1234567890",
"category_id": "1234567890",
"name": "インボイス",
"category_prompt": "VAT インボイス。インボイスコード、インボイス番号などのフィールドを含みます。",
"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: 'インボイス',
category_prompt: 'VAT インボイス。インボイスコード、インボイス番号などのフィールドを含みます。',
extract_model: 'Acgpt',
with_detail: true
})
};
fetch('https://docflow.textin.ai/api/app-api/sip/platform/v2/category/update', 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/update",
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' => 'インボイス',
'category_prompt' => 'VAT インボイス。インボイスコード、インボイス番号などのフィールドを含みます。',
'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/update"
payload := strings.NewReader("{\n \"workspace_id\": \"1234567890\",\n \"category_id\": \"1234567890\",\n \"name\": \"インボイス\",\n \"category_prompt\": \"VAT インボイス。インボイスコード、インボイス番号などのフィールドを含みます。\",\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/update")
.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\": \"インボイス\",\n \"category_prompt\": \"VAT インボイス。インボイスコード、インボイス番号などのフィールドを含みます。\",\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/update")
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\": \"インボイス\",\n \"category_prompt\": \"VAT インボイス。インボイスコード、インボイス番号などのフィールドを含みます。\",\n \"extract_model\": \"Acgpt\",\n \"with_detail\": true\n}"
response = http.request(request)
puts response.read_body{
"code": 200,
"msg": "<string>",
"result": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"category_prompt": "<string>",
"extract_model": "<string>",
"enabled": 123
}
}ファイルカテゴリ
ファイルカテゴリを更新
指定したファイルカテゴリ情報を更新します。
注意: extract_model を設定すると、このカテゴリ配下のすべてのフィールドとテーブルの抽出モデルが連鎖的に上書きされます。
POST
/
api
/
app-api
/
sip
/
platform
/
v2
/
category
/
update
ファイルカテゴリを更新
curl --request POST \
--url https://docflow.textin.ai/api/app-api/sip/platform/v2/category/update \
--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": "インボイス",
"category_prompt": "VAT インボイス。インボイスコード、インボイス番号などのフィールドを含みます。",
"extract_model": "Acgpt",
"with_detail": true
}
'import requests
url = "https://docflow.textin.ai/api/app-api/sip/platform/v2/category/update"
payload = {
"workspace_id": "1234567890",
"category_id": "1234567890",
"name": "インボイス",
"category_prompt": "VAT インボイス。インボイスコード、インボイス番号などのフィールドを含みます。",
"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: 'インボイス',
category_prompt: 'VAT インボイス。インボイスコード、インボイス番号などのフィールドを含みます。',
extract_model: 'Acgpt',
with_detail: true
})
};
fetch('https://docflow.textin.ai/api/app-api/sip/platform/v2/category/update', 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/update",
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' => 'インボイス',
'category_prompt' => 'VAT インボイス。インボイスコード、インボイス番号などのフィールドを含みます。',
'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/update"
payload := strings.NewReader("{\n \"workspace_id\": \"1234567890\",\n \"category_id\": \"1234567890\",\n \"name\": \"インボイス\",\n \"category_prompt\": \"VAT インボイス。インボイスコード、インボイス番号などのフィールドを含みます。\",\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/update")
.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\": \"インボイス\",\n \"category_prompt\": \"VAT インボイス。インボイスコード、インボイス番号などのフィールドを含みます。\",\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/update")
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\": \"インボイス\",\n \"category_prompt\": \"VAT インボイス。インボイスコード、インボイス番号などのフィールドを含みます。\",\n \"extract_model\": \"Acgpt\",\n \"with_detail\": true\n}"
response = http.request(request)
puts response.read_body{
"code": 200,
"msg": "<string>",
"result": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"category_prompt": "<string>",
"extract_model": "<string>",
"enabled": 123
}
}ボディ
application/json
ワークスペース ID
例:
"1234567890"
ファイルカテゴリ ID
例:
"1234567890"
ファイルカテゴリ名
Maximum string length:
50例:
"インボイス"
分類用プロンプト
Maximum string length:
150例:
"VAT インボイス。インボイスコード、インボイス番号などのフィールドを含みます。"
有効化ステータス
- 0: 無効
- 1: 有効
- 2: 下書き
利用可能なオプション:
0, 1, 2 抽出モデル, cascades to all fields and tables when set
- Auto: 抽出モデルを自動でマッチング
- Acgpt: 高速で安定した抽出結果
- Acgpt-VL: VLM。シンプルな抽出に適しています(≤10 ページ)
- DF-M1: 複雑な文書理解に適しています
利用可能なオプション:
Auto, Acgpt, Acgpt-VL, DF-M1 例:
"Acgpt"
完全な詳細を返すかどうか。true の場合、子レベルのフィールド/テーブルを除くカテゴリ自身の情報を返します。 未設定または false の場合、code/msg のみを返します。
⌘I

