Skip to main content
POST
Update Split Configuration

Authorizations

x-ti-app-id
string
header
required
x-ti-secret-code
string
header
required

Body

application/json
workspace_id
string
required

Workspace ID. Requires WORKSPACE_CONFIG permission and access to this workspace.

scope
enum<string>
required

Configuration scope: workspace or category. When scope is category, category_id is required.

Available options:
workspace,
category
rule_mode
enum<string>
required

Rule source: workspaces support default (system defaults) or custom; categories support inherit (follow the workspace) or custom. An inheriting category uses workspace rules and prompts but retains its own constraint.

Available options:
default,
inherit,
custom
rule_order
enum<string>[]
required

Rules saved for this scope, ordered from highest to lowest priority. Send an empty array for default/inherit. Custom mode accepts 0–7 unique rules. Inherited workspace rules are not expanded here.

Maximum array length: 7

Split rule code. llm_judge asks the model to judge page continuity; configure its prompt with llm_prompt_mode and llm_prompt.

Available options:
page_same,
page_reset,
invoice_diff,
invoice_same,
page_seq,
table_continue,
llm_judge
category_id
string

Required for category scope and must belong to the specified workspace. Omit for workspace scope.

constraint
enum<string>
default:none

Category constraint: none; strict_single_page (single-page documents); strict_multi_page (multi-page documents); strict_once (one document in this category). Workspace scope only supports none.

Available options:
none,
strict_single_page,
strict_multi_page,
strict_once
llm_prompt_mode
enum<string>
default:default

Prompt source for the llm_judge rule: default uses the system prompt; custom uses llm_prompt. This setting is not a split rule.

Available options:
default,
custom
llm_prompt
string | null

Custom instructions for llm_judge, for example: use titles and context to decide whether adjacent pages belong to the same document. Must be nonblank when this rule is enabled and llm_prompt_mode=custom.

Response

On success, code is 200 and result contains the split configuration. On failure, code identifies the error and msg explains the reason.

code
integer<int64>
required

Business status code: 200 indicates success; other values indicate failure.

Example:

200

msg
string
required

Response message; explains the reason when the request fails.

Example:

"success"

result
object | null

Saved split configuration on success; null or omitted on failure.