> ## Documentation Index
> Fetch the complete documentation index at: https://docs-docflow.textin.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Split Configuration

> Read the split configuration saved for a workspace or category.



## OpenAPI

````yaml /docflow/en/rest-api/openapi.bundle.yaml get /api/app-api/sip/platform/v2/split-config/get
openapi: 3.0.0
info:
  title: DocFlow API
  description: >-
    DocFlow REST API, providing file upload and file processing result retrieval
    capabilities
  version: 2.14.1
servers:
  - url: https://docflow.textin.com
security:
  - ApiId: []
    SecretCode: []
paths:
  /api/app-api/sip/platform/v2/split-config/get:
    get:
      tags:
        - Split Configuration
      summary: Get Split Configuration
      description: Read the split configuration saved for a workspace or category.
      operationId: getSplitConfig
      parameters:
        - name: workspace_id
          in: query
          required: true
          description: >-
            Workspace ID. Requires WORKSPACE_CONFIG permission and access to
            this workspace.
          schema:
            type: string
        - name: scope
          in: query
          required: true
          description: >-
            Configuration scope: workspace or category. When scope is category,
            category_id is required.
          schema:
            type: string
            enum:
              - workspace
              - category
        - name: category_id
          in: query
          required: false
          description: >-
            Required for category scope and must belong to the specified
            workspace. Omit for workspace scope.
          schema:
            type: string
      responses:
        '200':
          description: >-
            On success, code is 200 and result contains the split configuration.
            On failure, code identifies the error and msg explains the reason.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SplitConfigResponse'
              examples:
                success:
                  value:
                    code: 200
                    msg: success
                    result:
                      workspace_id: '2081651727503572992'
                      scope: workspace
                      rule_mode: custom
                      rule_order:
                        - page_reset
                        - llm_judge
                      constraint: none
                      llm_prompt_mode: default
                categoryNotFound:
                  value:
                    code: 1005025000
                    msg: 'Category does not exist: 2081651727503572993'
                    data: null
        '400':
          description: >-
            Request validation failed. See code, msg, and the error examples.
            Malformed JSON or IDs use the common HTTP 400 response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SplitConfigError'
              examples:
                error1005025100:
                  value:
                    code: 1005025100
                    msg: Invalid split configuration scope or category parameter
                    result: null
components:
  schemas:
    SplitConfigResponse:
      type: object
      additionalProperties: true
      required:
        - code
        - msg
      properties:
        code:
          type: integer
          format: int64
          description: >-
            Business status code: 200 indicates success; other values indicate
            failure.
          example: 200
        msg:
          type: string
          description: Response message; explains the reason when the request fails.
          example: success
        result:
          $ref: '#/components/schemas/SplitConfig'
    SplitConfigError:
      type: object
      required:
        - code
        - msg
        - result
      properties:
        code:
          type: integer
          format: int64
          description: Business error code. Use this field to identify the error type.
        msg:
          type: string
          description: >-
            Localized explanation of the error. See response examples for each
            error code.
        result:
          type: object
          nullable: true
          enum:
            - null
          example: null
          description: Null when the request fails.
    SplitConfig:
      type: object
      description: Saved split configuration on success; null or omitted on failure.
      required:
        - workspace_id
        - scope
        - rule_mode
        - rule_order
        - constraint
        - llm_prompt_mode
      properties:
        workspace_id:
          type: string
          description: Workspace ID
          example: '2081651727503572992'
        scope:
          type: string
          description: 'Configuration scope: workspace or category.'
          enum:
            - workspace
            - category
        category_id:
          type: string
          nullable: true
          description: Category ID; returned for category scope
        rule_mode:
          type: string
          description: >-
            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.
          enum:
            - default
            - inherit
            - custom
        rule_order:
          type: array
          description: >-
            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.
          items:
            $ref: '#/components/schemas/SplitRule'
        constraint:
          type: string
          description: >-
            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.
          enum:
            - none
            - strict_single_page
            - strict_multi_page
            - strict_once
        llm_prompt_mode:
          type: string
          description: >-
            Prompt source for the llm_judge rule: default uses the system
            prompt; custom uses llm_prompt. This setting is not a split rule.
          enum:
            - default
            - custom
        llm_prompt:
          type: string
          nullable: true
          description: >-
            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. Omitted when not configured.
      nullable: true
    SplitRule:
      type: string
      enum:
        - page_same
        - page_reset
        - invoice_diff
        - invoice_same
        - page_seq
        - table_continue
        - llm_judge
      description: >-
        Split rule code. llm_judge asks the model to judge page continuity;
        configure its prompt with llm_prompt_mode and llm_prompt.
  securitySchemes:
    ApiId:
      type: apiKey
      in: header
      name: x-ti-app-id
    SecretCode:
      type: apiKey
      in: header
      name: x-ti-secret-code

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.