Skip to main content
GET
/
api
/
app-api
/
sip
/
platform
/
v2
/
category
/
list
Get Workspace File Category List
curl --request GET \
  --url https://docflow.textin.ai/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": "Invoice",
        "description": "VAT invoice type",
        "category_prompt": "VAT invoice, including fields such as invoice code, invoice number, etc.",
        "extract_model": "Model 1"
      }
    ]
  }
}

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"

​
page
integer
default:1

Page number

​
page_size
integer
default:20

Page size

Required range: 1 <= x <= 100
​
enabled
enum<string>
default:1

Enabled status

  • all: All
  • 1: Enabled
  • 0: Disabled
  • 2: Draft
Available options:
all,
1,
0,
2

Response

200 - application/json

Successfully retrieved workspace file category list

​
code
integer
required

Status code

Example:

200

​
msg
string
required

Status description

​
result
object