メインコンテンツへスキップ
GET
/
api
/
app-api
/
sip
/
platform
/
v2
/
category
/
list
ワークスペースのファイルカテゴリ一覧を取得
curl --request GET \
  --url https://docflow.textin.com/api/app-api/sip/platform/v2/category/list \
  --header 'x-ti-app-id: <api-key>' \
  --header 'x-ti-secret-code: <api-key>'
{
  "code": 200,
  "msg": "<string>",
  "result": {
    "total": 100,
    "page": 1,
    "page_size": 20,
    "categories": [
      {
        "id": "1234567890",
        "name": "インボイス",
        "description": "VAT インボイスタイプ",
        "category_prompt": "VAT インボイス。インボイスコード、インボイス番号などのフィールドを含みます。",
        "extract_model": "Model 1"
      }
    ]
  }
}

承認

x-ti-app-id
string
header
必須
x-ti-secret-code
string
header
必須

クエリパラメータ

workspace_id
string
必須

ワークスペース ID

:

"1234567890"

page
integer
デフォルト:1

ページ番号

page_size
integer
デフォルト:20

ページサイズ

必須範囲: 1 <= x <= 100
enabled
enum<string>
デフォルト:1

有効化ステータス

  • all: All
  • 1: 有効
  • 0: 無効
  • 2: 下書き
利用可能なオプション:
all,
1,
0,
2

レスポンス

200 - application/json

ワークスペースのファイルカテゴリリストを正常に取得しました

code
integer
必須

ステータスコード

:

200

msg
string
必須

ステータス説明

result
object