# Docflow API

## Docs

- [Product Introduction](https://docs-docflow.textin.ai/docflow-global/en/00-overview/intro.md)
- [Quick Start](https://docs-docflow.textin.ai/docflow-global/en/00-overview/quickstart.md): Reference examples to quickly integrate Docflow functionality with APIs
- [Access Credentials](https://docs-docflow.textin.ai/docflow-global/en/00-overview/auth.md): How to obtain and use APIs access credentials
- [Enterprise Multi-Tenant](https://docs-docflow.textin.ai/docflow-global/en/00-overview/enterprise_multi_tenant.md): API call instructions for enterprise multi-tenant scenarios
- [Coding Agent Integration Overview](https://docs-docflow.textin.ai/docflow-global/en/20-coding-guide/intro.md): Quickly integrate TextIn Docflow Document Skill into AI Coding Agents for intelligent document retrieval and code generation
- [Quick Start](https://docs-docflow.textin.ai/docflow-global/en/20-coding-guide/quickstart.md): Integrate TextIn Docflow Document Skill in three steps
- [Install Coding Agent](https://docs-docflow.textin.ai/docflow-global/en/20-coding-guide/install-coding-agent.md): Choose an AI Coding tool that supports MCP
- [Install Docflow Document MCP](https://docs-docflow.textin.ai/docflow-global/en/20-coding-guide/install-docflow-mcp.md): Connect to TextIn Docflow Document MCP service to enable document retrieval for your Agent
- [Install Docflow Document Skill](https://docs-docflow.textin.ai/docflow-global/en/20-coding-guide/install-docflow-skill.md): Install Docflow Document Skill for your Coding Agent to enhance document understanding and code generation
- [Search Documents](https://docs-docflow.textin.ai/docflow-global/en/20-coding-guide/example-search-docs.md): Use Coding Agent to quickly search TextIn Docflow documentation
- [Generate Sample Code](https://docs-docflow.textin.ai/docflow-global/en/20-coding-guide/example-generate-code.md): Let Agent automatically generate Docflow API calling code based on documentation
- [Quickstart](https://docs-docflow.textin.ai/docflow-global/en/02-workspace/quickstart.md): Quick API integration of workspace management features
- [Quickstart](https://docs-docflow.textin.ai/docflow-global/en/10-category-management/quickstart.md): Quick API integration of file category management features
- [Fields Management](https://docs-docflow.textin.ai/docflow-global/en/10-category-management/fields_management.md): Manage regular fields and table fields under file categories
- [Tables Management](https://docs-docflow.textin.ai/docflow-global/en/10-category-management/tables_management.md): Manage table configurations under file categories
- [Samples Management](https://docs-docflow.textin.ai/docflow-global/en/10-category-management/samples_management.md): Manage sample files for file categories
- [Quick Start](https://docs-docflow.textin.ai/docflow-global/en/01-upload/quickstart.md): Reference examples to quickly integrate document upload functionality with APIs
- [Upload by URLs](https://docs-docflow.textin.ai/docflow-global/en/01-upload/upload_by_urls.md): Upload documents to DocFlow using file URLs
- [Response JSON Structure Description](https://docs-docflow.textin.ai/docflow-global/en/01-upload/response.md)
- [Synchronous Upload](https://docs-docflow.textin.ai/docflow-global/en/01-upload/upload_sync.md): Upload file synchronously and wait for processing to complete, returning processing results directly
- [File Format Support](https://docs-docflow.textin.ai/docflow-global/en/01-upload/support_format.md)
- [Task Status Query](https://docs-docflow.textin.ai/docflow-global/en/01-upload/task_status.md): Learn how to query task status, failure reasons, task duration, and other information
- [Quick Start](https://docs-docflow.textin.ai/docflow-global/en/03-parse/quickstart.md): Reference examples to quickly integrate document parsing functionality with APIs
- [Coordinate System](https://docs-docflow.textin.ai/docflow-global/en/03-parse/coordinate.md)
- [Parsing Result Visualization](https://docs-docflow.textin.ai/docflow-global/en/03-parse/visualization.md): How to obtain precise coordinates from parsing results and display them on the interface
- [Quick Start](https://docs-docflow.textin.ai/docflow-global/en/04-classify/quickstart.md): Reference examples to quickly integrate document classification functionality with APIs
- [Classification Only](https://docs-docflow.textin.ai/docflow-global/en/04-classify/target_process.md)
- [Specify Classification Upload](https://docs-docflow.textin.ai/docflow-global/en/04-classify/manual.md): Specify the file category during upload to skip the automatic classification process and proceed directly to extraction.
- [Amend File Category](https://docs-docflow.textin.ai/docflow-global/en/04-classify/amend_category.md): For normal tasks, use the amend category API to modify file categories
- [Quick Start](https://docs-docflow.textin.ai/docflow-global/en/05-split/quickstart.md): Reference examples to quickly integrate document splitting functionality with APIs
- [File Splitting](https://docs-docflow.textin.ai/docflow-global/en/05-split/split.md)
- [Multi-Image Cropping](https://docs-docflow.textin.ai/docflow-global/en/05-split/crop.md): Intelligently recognize and crop documents containing multiple independent images on one page, supporting scenarios like expense receipt pasting
- [Amend File Category (File Split)](https://docs-docflow.textin.ai/docflow-global/en/05-split/amend_category_split.md): For file split tasks, use the amend category API to modify the category and page numbers of split files
- [Amend File Category (Multi-Image Crop)](https://docs-docflow.textin.ai/docflow-global/en/05-split/amend_category_crop.md): For multi-image crop tasks, use the amend category API to modify the category of cropped files
- [Quick Start](https://docs-docflow.textin.ai/docflow-global/en/06-extract/quickstart.md): Reference examples to quickly integrate document extraction functionality with APIs
- [Basic Field Information](https://docs-docflow.textin.ai/docflow-global/en/06-extract/fields.md): Detailed explanation of field information structure and processing methods in document extraction
- [Table Field Information](https://docs-docflow.textin.ai/docflow-global/en/06-extract/tables.md): Detailed explanation of table field information structure and processing methods in document extraction
- [Stamp Information](https://docs-docflow.textin.ai/docflow-global/en/06-extract/stamps.md): Detailed explanation of stamp information structure and processing methods in document extraction
- [Handwriting Information](https://docs-docflow.textin.ai/docflow-global/en/06-extract/handwritings.md): Detailed explanation of handwriting information structure and processing methods in document extraction
- [Extract Specific Fields](https://docs-docflow.textin.ai/docflow-global/en/06-extract/extract_specific_fields.md): Extract additional fields or re-extract existing fields for tasks that have completed extraction
- [Quick Start](https://docs-docflow.textin.ai/docflow-global/en/07-review/quickstart.md): Learn how to use the intelligent review feature in the interface
- [Rule Repository Management](https://docs-docflow.textin.ai/docflow-global/en/07-review/rule_management.md): Manage review rule repositories, rule groups, and rules via REST API
- [Create Review Task](https://docs-docflow.textin.ai/docflow-global/en/07-review/create_task.md): Create review tasks via REST API
- [Get Review Results](https://docs-docflow.textin.ai/docflow-global/en/07-review/get_result.md): Get review task results via REST API and use review results
- [Retry Review Task](https://docs-docflow.textin.ai/docflow-global/en/07-review/retry_task.md): Retry review tasks or specific rules in review tasks via REST API
- [Quick Start](https://docs-docflow.textin.ai/docflow-global/en/08-delete/quickstart.md): Reference examples to quickly integrate document deletion functionality with API
- [Quick Start](https://docs-docflow.textin.ai/docflow-global/en/09-retry/quickstart.md): Reference examples to quickly integrate document retry functionality with API
- [How to Get Workspace ID](https://docs-docflow.textin.ai/docflow-global/en/100-faq/get_workspace_id.md)
- [How to Get Enterprise ID](https://docs-docflow.textin.ai/docflow-global/en/100-faq/get_enterprise_id.md)
- [How to Configure File Categories](https://docs-docflow.textin.ai/docflow-global/en/100-faq/setup_category.md)
- [Chinese Category Parameter Passing Issues](https://docs-docflow.textin.ai/docflow-global/en/100-faq/chinese_category_param.md): Solving issues with Chinese or other non-English category names in API parameter passing
- [OpenAPI File Download](https://docs-docflow.textin.ai/docflow-global/en/100-faq/openapi_download.md)
- [Upload File](https://docs-docflow.textin.ai/api-reference/upload-file.md)
- [Upload File Synchronously](https://docs-docflow.textin.ai/api-reference/upload-file-synchronously.md): Upload file and wait for processing to complete, returning processing results directly
- [Get File Processing Result List](https://docs-docflow.textin.ai/api-reference/get-file-processing-result-list.md)
- [Update File Processing Result](https://docs-docflow.textin.ai/api-reference/update-file-processing-result.md): Update file processing result. Usually used after manual review and proofreading to upload modified key-value pairs, overriding automatically recognized results.
- [Delete Tasks](https://docs-docflow.textin.ai/api-reference/delete-tasks.md): Delete files by conditions. Files matching any condition will be deleted.
- [Extract Specific Fields](https://docs-docflow.textin.ai/api-reference/extract-specific-fields.md): For tasks that have completed extraction, extract additional fields for the task, or re-extract individual existing fields. Returns the complete extraction result of all fields. The return structure is the same as `/api/app-api/sip/platform/v2/file/fetch`.
- [Retry File Processing](https://docs-docflow.textin.ai/api-reference/retry-file-processing.md): Retry processing a file.
- [Amend File Category](https://docs-docflow.textin.ai/api-reference/amend-file-category.md): - For regular tasks, modify the file category of the regular task - For document splitting tasks, modify the file type and page numbers of the split files - For multi-image cropping tasks, modify the file type of the cropped files
- [Generate a short-lived token](https://docs-docflow.textin.ai/api-reference/generate-a-short-lived-token.md): Generate a short-lived token (for iframe scenarios). The token is valid for 1 day.
- [Create Workspace](https://docs-docflow.textin.ai/api-reference/workspace-management/create-workspace.md): Create a new workspace
- [Get Workspace List](https://docs-docflow.textin.ai/api-reference/workspace-management/get-workspace-list.md): Get list of all workspaces for the current user
- [Get Workspace Details](https://docs-docflow.textin.ai/api-reference/workspace-management/get-workspace-details.md): Get detailed information of a workspace by workspace ID
- [Update Workspace](https://docs-docflow.textin.ai/api-reference/workspace-management/update-workspace.md): Update information of a specified workspace
- [Delete Workspace](https://docs-docflow.textin.ai/api-reference/workspace-management/delete-workspace.md): Delete specified workspace(s)
- [Create File Category](https://docs-docflow.textin.ai/api-reference/file-category/create-file-category.md): Create a new file category in the specified workspace, requiring at least one sample file and at least one field configuration.
- [Get Workspace File Category List](https://docs-docflow.textin.ai/api-reference/file-category/get-workspace-file-category-list.md): Get workspace file category list
- [Update File Category](https://docs-docflow.textin.ai/api-reference/file-category/update-file-category.md): Update the specified file category information.
- [Delete File Category](https://docs-docflow.textin.ai/api-reference/file-category/delete-file-category.md): Delete the specified file categories
- [Get File Category Field List](https://docs-docflow.textin.ai/api-reference/file-category/get-file-category-field-list.md): Get file category field list, including regular fields and tables (with table fields)
- [Add File Category Fields](https://docs-docflow.textin.ai/api-reference/file-category/add-file-category-fields.md): Add multiple fields under the specified file category. All-or-nothing semantics — if any field fails validation, the entire batch fails.
- [Update File Category Fields](https://docs-docflow.textin.ai/api-reference/file-category/update-file-category-fields.md): Update multiple fields under the specified file category. All-or-nothing semantics.
- [Delete File Category Fields](https://docs-docflow.textin.ai/api-reference/file-category/delete-file-category-fields.md): Delete the specified file category fields, supports batch deletion of regular fields and table fields
- [Get File Category Table List](https://docs-docflow.textin.ai/api-reference/file-category/get-file-category-table-list.md): Get all tables configured under the specified file category
- [Add File Category Tables](https://docs-docflow.textin.ai/api-reference/file-category/add-file-category-tables.md): Add multiple tables under the specified file category (supports nested fields). All-or-nothing semantics.
- [Update File Category Tables](https://docs-docflow.textin.ai/api-reference/file-category/update-file-category-tables.md): Update multiple tables under the specified file category. All-or-nothing semantics.
- [Delete File Category Tables](https://docs-docflow.textin.ai/api-reference/file-category/delete-file-category-tables.md): Delete the specified file category tables, supports batch deletion
- [Upload Category Samples](https://docs-docflow.textin.ai/api-reference/file-category-samples/upload-category-samples.md): Upload multiple sample files for the specified file category, maximum 20 files
- [Get Category Sample List](https://docs-docflow.textin.ai/api-reference/file-category-samples/get-category-sample-list.md): Get the sample list of the specified file category
- [Download Category Samples (ZIP)](https://docs-docflow.textin.ai/api-reference/file-category-samples/download-category-samples-zip.md): Download multiple sample files of the specified category, packaged as a ZIP file. When sample_ids is not provided, all samples are downloaded.
- [Delete Category Samples](https://docs-docflow.textin.ai/api-reference/file-category-samples/delete-category-samples.md): Delete the specified category samples
- [Create Review Rule Repository](https://docs-docflow.textin.ai/api-reference/intelligent-review/create-review-rule-repository.md): Create review rule repository
- [Delete Review Rule Repository](https://docs-docflow.textin.ai/api-reference/intelligent-review/delete-review-rule-repository.md): Delete review rule repository
- [Update Review Rule Repository](https://docs-docflow.textin.ai/api-reference/intelligent-review/update-review-rule-repository.md): Update review rule repository
- [Get Review Rule Repository List](https://docs-docflow.textin.ai/api-reference/intelligent-review/get-review-rule-repository-list.md): Get review rule repository list, including rule groups and rules information under the repository
- [Get Review Rule Repository](https://docs-docflow.textin.ai/api-reference/intelligent-review/get-review-rule-repository.md): Get review rule repository
- [Create Review Rule Group](https://docs-docflow.textin.ai/api-reference/intelligent-review/create-review-rule-group.md): Create review rule group
- [Delete Review Rule Group](https://docs-docflow.textin.ai/api-reference/intelligent-review/delete-review-rule-group.md): Delete review rule group
- [Update Review Rule Group](https://docs-docflow.textin.ai/api-reference/intelligent-review/update-review-rule-group.md): Update review rule group
- [Create Review Rule](https://docs-docflow.textin.ai/api-reference/intelligent-review/create-review-rule.md): Create review rule
- [Update Review Rule](https://docs-docflow.textin.ai/api-reference/intelligent-review/update-review-rule.md): Update review rule
- [Delete Review Rule](https://docs-docflow.textin.ai/api-reference/intelligent-review/delete-review-rule.md): Delete review rule
- [Submit Review Task](https://docs-docflow.textin.ai/api-reference/intelligent-review/submit-review-task.md): Submit review task
- [Delete Review Task](https://docs-docflow.textin.ai/api-reference/intelligent-review/delete-review-task.md): Delete review task
- [Get Review Task Result](https://docs-docflow.textin.ai/api-reference/intelligent-review/get-review-task-result.md): Get review task result
- [Retry Review Task](https://docs-docflow.textin.ai/api-reference/intelligent-review/retry-review-task.md): Retry review task
- [Retry Specific Rule in Review Task](https://docs-docflow.textin.ai/api-reference/intelligent-review/retry-specific-rule-in-review-task.md): Retry a specific rule in the review task.
- [Add Single File Category Field](https://docs-docflow.textin.ai/api-reference/deprecated/add-single-file-category-field.md): Add a new field under the specified file category, supports both regular fields and table fields
- [Update Single File Category Field](https://docs-docflow.textin.ai/api-reference/deprecated/update-single-file-category-field.md): Update the specified file category field, supports both regular fields and table fields
- [Add Single File Category Table](https://docs-docflow.textin.ai/api-reference/deprecated/add-single-file-category-table.md): Add a new table under the specified file category
- [Update Single File Category Table](https://docs-docflow.textin.ai/api-reference/deprecated/update-single-file-category-table.md): Update the specified file category table information
- [Upload Single Category Sample](https://docs-docflow.textin.ai/api-reference/deprecated/upload-single-category-sample.md): Upload a sample file for the specified file category
- [Download Single Category Sample](https://docs-docflow.textin.ai/api-reference/deprecated/download-single-category-sample.md): Download the specified category sample file
- [Python sdk](https://docs-docflow.textin.ai/docflow-global/en/11-sdk/python_sdk.md)
- [Changelog](https://docs-docflow.textin.ai/docflow-global/en/12-changelog/changelog.md): DocFlow API documentation changelog

## OpenAPI Specs

- [openapi.bundle](https://docs-docflow.textin.ai/docflow-global/ja/rest-api/openapi.bundle.yaml)
- [openapi_full](https://docs-docflow.textin.ai/_archive/cn/rest-api/openapi_full.yaml)
- [openapi](https://docs-docflow.textin.ai/api-reference/openapi.json)