Quickstart

A Workspace is the basic unit in DocFlow for organizing and isolating document processing tasks. Each workspace can contain file categories, review rule repositories, and other resources, facilitating multi-tenant or multi-project management.

This guide introduces how to use workspace-related APIs: create, list, get, update, and delete.

Create Workspace

Create a new workspace:

curl -X POST \
  -H "x-ti-app-id: <your-app-id>" \
  -H "x-ti-secret-code: <your-secret-code>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My Workspace",
    "description": "This is a workspace for processing invoices",
    "enterprise_id": 12345,
    "auth_scope": 1
  }' \
  "https://docflow.textin.ai/api/app-api/sip/platform/v2/workspace/create"

import requests

ti_app_id = "<your-app-id>"
ti_secret_code = "<your-secret-code>"
host = "https://docflow.textin.ai"
url = "/api/app-api/sip/platform/v2/workspace/create"

payload = {
    "name": "My Workspace",
    "description": "This is a workspace for processing invoices",
    "enterprise_id": 12345,
    "auth_scope": 1  # 0: Private, 1: Enterprise-wide
}

resp = requests.post(
    url=f"{host}{url}",
    json=payload,
    headers={
        "x-ti-app-id": ti_app_id,
        "x-ti-secret-code": ti_secret_code,
    },
    timeout=30,
)

result = resp.json()
if result.get("code") == 200:
    workspace_id = result.get("result", {}).get("workspace_id")
    print(f"Workspace created successfully, ID: {workspace_id}")
else:
    print(f"Creation failed: {result.get('msg')}")

Request Parameters:

name (required): Workspace name, max length 50
description (optional): Workspace description, max length 200
enterprise_id (required): Enterprise organization ID
auth_scope (required): Collaboration scope, 0: Private, 1: Enterprise-wide

Response Example:

{
  "code": 200,
  "msg": "success",
  "result": {
    "workspace_id": "1234567890"
  }
}

List Workspaces

Get all workspaces for the current user:

curl \
  -H "x-ti-app-id: <your-app-id>" \
  -H "x-ti-secret-code: <your-secret-code>" \
  "https://docflow.textin.ai/api/app-api/sip/platform/v2/workspace/list?enterprise_id=12345&page=1&page_size=20"

import requests

ti_app_id = "<your-app-id>"
ti_secret_code = "<your-secret-code>"
enterprise_id = 12345

host = "https://docflow.textin.ai"
url = "/api/app-api/sip/platform/v2/workspace/list"

resp = requests.get(
    url=f"{host}{url}",
    params={
        "enterprise_id": enterprise_id,
        "page": 1,
        "page_size": 20
    },
    headers={
        "x-ti-app-id": ti_app_id,
        "x-ti-secret-code": ti_secret_code,
    },
    timeout=30,
)

result = resp.json()
if result.get("code") == 200:
    workspaces = result.get("result", {}).get("workspaces", [])
    total = result.get("result", {}).get("total", 0)
    print(f"Found {total} workspaces")
    for workspace in workspaces:
        print(f"Workspace ID: {workspace.get('workspace_id')}, Name: {workspace.get('name')}")
else:
    print(f"Retrieval failed: {result.get('msg')}")

Request Parameters:

enterprise_id (required): Enterprise ID
page (optional): Page number, default is 1
page_size (optional): Items per page, default is 20

Response Example:

{
  "code": 200,
  "msg": "success",
  "result": {
    "total": 10,
    "page": 1,
    "page_size": 20,
    "workspaces": [
      {
        "workspace_id": "1234567890",
        "name": "My Workspace",
        "description": "This is a workspace for processing invoices",
        "auth_scope": 1,
        "manage_account_id": "admin_123456",
        "manage_account_name": "John Doe",
        "callback_url": "https://example.com/callback",
        "callback_retry_time": 3
      }
    ]
  }
}

Get Workspace Details

Get detailed information about a workspace by its ID:

curl \
  -H "x-ti-app-id: <your-app-id>" \
  -H "x-ti-secret-code: <your-secret-code>" \
  "https://docflow.textin.ai/api/app-api/sip/platform/v2/workspace/get?workspace_id=1234567890"

import requests

ti_app_id = "<your-app-id>"
ti_secret_code = "<your-secret-code>"
workspace_id = "1234567890"

host = "https://docflow.textin.ai"
url = "/api/app-api/sip/platform/v2/workspace/get"

resp = requests.get(
    url=f"{host}{url}",
    params={"workspace_id": workspace_id},
    headers={
        "x-ti-app-id": ti_app_id,
        "x-ti-secret-code": ti_secret_code,
    },
    timeout=30,
)

result = resp.json()
if result.get("code") == 200:
    workspace = result.get("result", {})
    print(f"Workspace name: {workspace.get('name')}")
    print(f"Description: {workspace.get('description')}")
    print(f"Administrator: {workspace.get('manage_account_name')}")
else:
    print(f"Retrieval failed: {result.get('msg')}")

Request Parameters:

workspace_id (required): Workspace ID

Update Workspace

Update information for a specified workspace:

curl -X POST \
  -H "x-ti-app-id: <your-app-id>" \
  -H "x-ti-secret-code: <your-secret-code>" \
  -H "Content-Type: application/json" \
  -d '{
    "workspace_id": "1234567890",
    "name": "Updated Workspace Name",
    "description": "Updated description",
    "auth_scope": 1,
    "callback_url": "https://example.com/callback",
    "callback_retry_time": 3
  }' \
  "https://docflow.textin.ai/api/app-api/sip/platform/v2/workspace/update"

import requests

ti_app_id = "<your-app-id>"
ti_secret_code = "<your-secret-code>"
workspace_id = "1234567890"

host = "https://docflow.textin.ai"
url = "/api/app-api/sip/platform/v2/workspace/update"

payload = {
    "workspace_id": workspace_id,
    "name": "Updated Workspace Name",
    "description": "Updated description",
    "auth_scope": 1,
    "callback_url": "https://example.com/callback",
    "callback_retry_time": 3
}

resp = requests.post(
    url=f"{host}{url}",
    json=payload,
    headers={
        "x-ti-app-id": ti_app_id,
        "x-ti-secret-code": ti_secret_code,
    },
    timeout=30,
)

result = resp.json()
if result.get("code") == 200:
    print("Workspace updated successfully")
else:
    print(f"Update failed: {result.get('msg')}")

Request Parameters:

workspace_id (required): Workspace ID
name (required): Workspace name, max length 50
description (optional): Workspace description, max length 200
auth_scope (required): Collaboration scope, 0: Private, 1: Enterprise-wide
callback_url (optional): Callback URL
callback_retry_time (optional): Number of callback retries, range 0-3

Delete Workspace

Delete specified workspace(s) (supports batch deletion):

curl -X POST \
  -H "x-ti-app-id: <your-app-id>" \
  -H "x-ti-secret-code: <your-secret-code>" \
  -H "Content-Type: application/json" \
  -d '{
    "workspace_ids": ["1234567890", "0987654321"]
  }' \
  "https://docflow.textin.ai/api/app-api/sip/platform/v2/workspace/delete"

import requests

ti_app_id = "<your-app-id>"
ti_secret_code = "<your-secret-code>"

host = "https://docflow.textin.ai"
url = "/api/app-api/sip/platform/v2/workspace/delete"

payload = {
    "workspace_ids": ["1234567890", "0987654321"]
}

resp = requests.post(
    url=f"{host}{url}",
    json=payload,
    headers={
        "x-ti-app-id": ti_app_id,
        "x-ti-secret-code": ti_secret_code,
    },
    timeout=30,
)

result = resp.json()
if result.get("code") == 200:
    print("Workspace deleted successfully")
else:
    print(f"Deletion failed: {result.get('msg')}")

Request Parameters:

workspace_ids (required): Array of workspace IDs to delete

Deleting a workspace will also delete all resources under it (including file categories, review rule repositories, etc.). Please proceed with caution.

Next Steps

Learn Category Management - Create and manage file categories in workspace
Learn Review Rule Management - Create review rule repositories in workspace

Overview

MCP&Skill

Workspace Management

Category Management

Upload

Parse

Classify

Split

Extract

Review

Delete Tasks

Retry Tasks

FAQ

Create Workspace

List Workspaces

Get Workspace Details

Update Workspace

Delete Workspace

Next Steps

​Create Workspace

​List Workspaces

​Get Workspace Details

​Update Workspace

​Delete Workspace

​Next Steps

Create Workspace

List Workspaces

Get Workspace Details

Update Workspace

Delete Workspace

Next Steps