# Docflow API

## Docs

- [上传文件](https://docs-docflow.textin.com/api-reference/上传文件.md)
- [修改文件类别](https://docs-docflow.textin.com/api-reference/修改文件类别.md): - 对于普通任务，修改普通任务文件类别 - 对于文档拆分任务，修改拆分后的文件类型和页码 - 对于多图切分任务，修改切分后的文件类型
- [删除任务](https://docs-docflow.textin.com/api-reference/删除任务.md): 按条件删除文件，满足任一条件即可删除。
- [同步上传文件](https://docs-docflow.textin.com/api-reference/同步上传文件.md): 同步上传文件并等待处理完成，返回处理结果
- [上传单个类别样本](https://docs-docflow.textin.com/api-reference/已废弃/上传单个类别样本.md): 为指定文件类别上传样本文件
- [下载单个类别样本](https://docs-docflow.textin.com/api-reference/已废弃/下载单个类别样本.md): 下载指定的类别样本文件
- [新增单个文件类别字段](https://docs-docflow.textin.com/api-reference/已废弃/新增单个文件类别字段.md): 在指定文件类别下新增一个字段，支持新增普通字段和表格字段
- [新增单个文件类别表格](https://docs-docflow.textin.com/api-reference/已废弃/新增单个文件类别表格.md): 在指定文件类别下新增一个表格
- [更新单个文件类别字段](https://docs-docflow.textin.com/api-reference/已废弃/更新单个文件类别字段.md): 更新指定文件类别字段的信息，支持普通字段和表格字段
- [更新单个文件类别表格](https://docs-docflow.textin.com/api-reference/已废弃/更新单个文件类别表格.md): 更新指定文件类别表格的信息
- [抽取特定字段](https://docs-docflow.textin.com/api-reference/抽取特定字段.md): 针对已经完成抽取的任务，为该任务抽取额外的字段，或重新抽取个别已有的字段。   返回所有字段的完整抽取结果。返回结构同`/api/app-api/sip/platform/v2/file/fetch`。
- [创建文件类别](https://docs-docflow.textin.com/api-reference/文件类别/创建文件类别.md): 在指定空间中创建一个新的文件类别，需要上传至少一个样本文件并配置至少一个字段。
- [删除文件类别](https://docs-docflow.textin.com/api-reference/文件类别/删除文件类别.md): 删除指定的文件类别
- [删除文件类别字段](https://docs-docflow.textin.com/api-reference/文件类别/删除文件类别字段.md): 删除指定的文件类别字段，支持批量删除普通字段和表格字段
- [删除文件类别表格](https://docs-docflow.textin.com/api-reference/文件类别/删除文件类别表格.md): 删除指定的文件类别表格，支持批量删除
- [新增文件类别字段](https://docs-docflow.textin.com/api-reference/文件类别/新增文件类别字段.md): 在指定文件类别下新增多个字段。全有全无语义：任一字段校验不通过则全部失败。
- [新增文件类别表格](https://docs-docflow.textin.com/api-reference/文件类别/新增文件类别表格.md): 在指定文件类别下新增多个表格（支持内嵌字段）。全有全无语义。
- [更新文件类别](https://docs-docflow.textin.com/api-reference/文件类别/更新文件类别.md): 更新指定文件类别的信息。
- [更新文件类别字段](https://docs-docflow.textin.com/api-reference/文件类别/更新文件类别字段.md): 更新指定文件类别下的多个字段。全有全无语义：任一字段校验不通过则全部失败。
- [更新文件类别表格](https://docs-docflow.textin.com/api-reference/文件类别/更新文件类别表格.md): 更新指定文件类别下的多个表格。全有全无语义。
- [获取文件类别下的表格列表](https://docs-docflow.textin.com/api-reference/文件类别/获取文件类别下的表格列表.md): 获取指定文件类别下配置的所有表格
- [获取文件类别字段列表](https://docs-docflow.textin.com/api-reference/文件类别/获取文件类别字段列表.md): 获取文件类别字段列表，包含普通字段和表格（含表格字段）
- [获取空间文件类别列表](https://docs-docflow.textin.com/api-reference/文件类别/获取空间文件类别列表.md): 获取空间文件类别列表
- [上传类别样本](https://docs-docflow.textin.com/api-reference/文件类别样本/上传类别样本.md): 为指定文件类别上传多个样本文件，最多20个
- [下载类别样本（ZIP）](https://docs-docflow.textin.com/api-reference/文件类别样本/下载类别样本（zip）.md): 下载指定类别的多个样本文件，打包为 ZIP 格式返回。不传 sample_ids 时下载全部样本。
- [删除类别样本](https://docs-docflow.textin.com/api-reference/文件类别样本/删除类别样本.md): 删除指定的类别样本
- [获取类别样本列表](https://docs-docflow.textin.com/api-reference/文件类别样本/获取类别样本列表.md): 获取指定文件类别的样本列表
- [创建审核规则](https://docs-docflow.textin.com/api-reference/智能审核/创建审核规则.md): 创建审核规则
- [创建审核规则库](https://docs-docflow.textin.com/api-reference/智能审核/创建审核规则库.md): 创建审核规则库
- [创建审核规则组](https://docs-docflow.textin.com/api-reference/智能审核/创建审核规则组.md): 创建审核规则组
- [删除审核任务](https://docs-docflow.textin.com/api-reference/智能审核/删除审核任务.md): 删除审核任务
- [删除审核规则](https://docs-docflow.textin.com/api-reference/智能审核/删除审核规则.md): 删除审核规则
- [删除审核规则库](https://docs-docflow.textin.com/api-reference/智能审核/删除审核规则库.md): 删除审核规则库
- [删除审核规则组](https://docs-docflow.textin.com/api-reference/智能审核/删除审核规则组.md): 删除审核规则组
- [新建审核任务](https://docs-docflow.textin.com/api-reference/智能审核/新建审核任务.md): 新建审核任务
- [更新审核规则](https://docs-docflow.textin.com/api-reference/智能审核/更新审核规则.md): 更新审核规则
- [更新审核规则库](https://docs-docflow.textin.com/api-reference/智能审核/更新审核规则库.md): 更新审核规则库
- [更新审核规则组](https://docs-docflow.textin.com/api-reference/智能审核/更新审核规则组.md): 更新审核规则组
- [获取审核结果](https://docs-docflow.textin.com/api-reference/智能审核/获取审核结果.md): 获取审核结果
- [获取审核规则库](https://docs-docflow.textin.com/api-reference/智能审核/获取审核规则库.md): 获取审核规则库
- [获取审核规则库列表](https://docs-docflow.textin.com/api-reference/智能审核/获取审核规则库列表.md): 获取审核规则库列表, 包含规则库下的规则组和规则信息
- [重新审核任务](https://docs-docflow.textin.com/api-reference/智能审核/重新审核任务.md): 重新审核任务
- [重新审核任务中的某条规则](https://docs-docflow.textin.com/api-reference/智能审核/重新审核任务中的某条规则.md): 重新审核任务中的某条规则。
- [更新文件处理结果](https://docs-docflow.textin.com/api-reference/更新文件处理结果.md): 更新文件处理结果。通常用于人工审核校对后，上传修改后的key-value，覆盖自动识别的结果。
- [生成短时间有效的token](https://docs-docflow.textin.com/api-reference/生成短时间有效的token.md): 生成短时间有效的token(用于iframe场景)
- [创建空间](https://docs-docflow.textin.com/api-reference/空间管理/创建空间.md): 创建一个新的工作空间
- [删除空间](https://docs-docflow.textin.com/api-reference/空间管理/删除空间.md): 删除指定的工作空间
- [更新空间](https://docs-docflow.textin.com/api-reference/空间管理/更新空间.md): 更新指定空间的信息
- [获取空间列表](https://docs-docflow.textin.com/api-reference/空间管理/获取空间列表.md): 获取当前用户的所有工作空间列表
- [获取空间详情](https://docs-docflow.textin.com/api-reference/空间管理/获取空间详情.md): 根据空间ID获取空间详细信息
- [获取文件处理结果列表](https://docs-docflow.textin.com/api-reference/获取文件处理结果列表.md)
- [重新处理文件](https://docs-docflow.textin.com/api-reference/重新处理文件.md): 重新处理文件。
- [AP 审单场景（无工作空间）](https://docs-docflow.textin.com/docflow/cn/00-overview/ap_review.md): 在财务部门 AP（应付账款）审单业务场景中，调用 DocFlow API 完成发票、采购订单、收货单等单据的自动化交叉审核。
- [AP 审单场景（已有工作空间）](https://docs-docflow.textin.com/docflow/cn/00-overview/ap_review_already_configured.md): 当已在docflow产品页完成工作空间创建、文件类别和审核规则库配置，通过 DocFlow API 完成文件上传，获取文件分类、抽取及智能审核结果的处理流程如下
- [与 Docflow 文档抽取的区别](https://docs-docflow.textin.com/docflow/cn/00-overview/atomic_capabilities_extract.md): 了解底层智能文档抽取 API (Entity Extraction) 与 Docflow 内置文档抽取的区别及适用场景
- [与 Docflow 文档解析的区别](https://docs-docflow.textin.com/docflow/cn/00-overview/atomic_capabilities_parse.md): 了解底层文档解析 API (xParse) 与 Docflow 内置文档解析的区别及适用场景
- [访问凭证](https://docs-docflow.textin.com/docflow/cn/00-overview/auth.md): 如何获取并使用API访问凭证
- [合同审核场景（无工作空间）](https://docs-docflow.textin.com/docflow/cn/00-overview/contract_review.md): 在合同审核场景中，调用 DocFlow API 对各类合同进行全面的财务条款、法务合规和文本质量自动化审核。
- [合同审核场景（已有工作空间）](https://docs-docflow.textin.com/docflow/cn/00-overview/contract_review_already_configured.md): 当已在docflow产品页完成工作空间创建、文件类别和审核规则库配置，通过 DocFlow API 完成文件上传，获取文件分类、抽取及智能审核结果的处理流程如下
- [企业多租户](https://docs-docflow.textin.com/docflow/cn/00-overview/enterprise_multi_tenant.md): 企业多租户场景下的API调用说明
- [费用报销场景（无工作空间）](https://docs-docflow.textin.com/docflow/cn/00-overview/expense_reimbursement.md): 在财务部门费用报销业务场景，调用 DocFlow API 完成文档全流程自动化处理
- [费用报销场景（已有工作空间）](https://docs-docflow.textin.com/docflow/cn/00-overview/expense_reimbursement_already_configured.md): 当已在docflow产品页完成工作空间创建、文件类别和审核规则库配置，通过 DocFlow API 完成文件上传，获取文件分类、抽取及智能审核结果的处理流程如下
- [产品简介](https://docs-docflow.textin.com/docflow/cn/00-overview/intro.md)
- [快速启动](https://docs-docflow.textin.com/docflow/cn/00-overview/quickstart.md): 参考示例，快速用API集成Docflow功能
- [快速启动](https://docs-docflow.textin.com/docflow/cn/01-upload/quickstart.md): 参考示例，快速用API集成文档上传功能
- [返回JSON结构说明](https://docs-docflow.textin.com/docflow/cn/01-upload/response.md)
- [文件格式支持](https://docs-docflow.textin.com/docflow/cn/01-upload/support_format.md)
- [任务状态查询](https://docs-docflow.textin.com/docflow/cn/01-upload/task_status.md): 了解如何查询任务状态、失败原因、任务耗时等信息
- [通过URL上传](https://docs-docflow.textin.com/docflow/cn/01-upload/upload_by_urls.md): 通过文件URL链接上传文档到DocFlow
- [同步上传](https://docs-docflow.textin.com/docflow/cn/01-upload/upload_sync.md): 同步上传文件并等待处理完成，直接返回处理结果
- [快速启动](https://docs-docflow.textin.com/docflow/cn/02-workspace/quickstart.md): 参考示例，快速用API集成工作空间管理功能
- [坐标体系](https://docs-docflow.textin.com/docflow/cn/03-parse/coordinate.md)
- [快速启动](https://docs-docflow.textin.com/docflow/cn/03-parse/quickstart.md): 参考示例，快速用API集成文档解析功能
- [解析结果可视化](https://docs-docflow.textin.com/docflow/cn/03-parse/visualization.md): 如何从解析结果获取精确坐标并在界面上展示
- [修改文件类别](https://docs-docflow.textin.com/docflow/cn/04-classify/amend_category.md): 对于普通任务，使用 修改文件类别 接口修改文件类别
- [指定分类上传](https://docs-docflow.textin.com/docflow/cn/04-classify/manual.md): 在上传时指定文件类别，跳过自动分类过程直接进入抽取
- [快速启动](https://docs-docflow.textin.com/docflow/cn/04-classify/quickstart.md): 参考示例，快速用API集成文档分类功能
- [仅使用分类](https://docs-docflow.textin.com/docflow/cn/04-classify/target_process.md)
- [修改文件类别（多图切分）](https://docs-docflow.textin.com/docflow/cn/05-split/amend_category_crop.md): 对于多图切分任务，使用 修改文件类别 接口修改切分后的文件类别
- [修改文件类别（文件拆分）](https://docs-docflow.textin.com/docflow/cn/05-split/amend_category_split.md): 对于文件拆分任务，使用 修改文件类别 接口修改拆分后的文件类别和页码
- [多图切分](https://docs-docflow.textin.com/docflow/cn/05-split/crop.md): 智能识别并切分一页包含多张独立图片的文档，支持报销贴票等场景
- [快速启动](https://docs-docflow.textin.com/docflow/cn/05-split/quickstart.md): 参考示例，快速用API集成文档拆分功能
- [文件拆分](https://docs-docflow.textin.com/docflow/cn/05-split/split.md)
- [抽取特定字段](https://docs-docflow.textin.com/docflow/cn/06-extract/extract_specific_fields.md): 针对已完成抽取的任务，抽取额外字段或重新抽取已有字段
- [基本字段信息](https://docs-docflow.textin.com/docflow/cn/06-extract/fields.md): 详细说明文档抽取中的字段信息结构和处理方法
- [手写信息](https://docs-docflow.textin.com/docflow/cn/06-extract/handwritings.md): 详细说明文档抽取中的手写信息结构和处理方法
- [快速启动](https://docs-docflow.textin.com/docflow/cn/06-extract/quickstart.md): 参考示例，快速用API集成文档抽取功能
- [印章信息](https://docs-docflow.textin.com/docflow/cn/06-extract/stamps.md): 详细说明文档抽取中的印章信息结构和处理方法
- [表格字段信息](https://docs-docflow.textin.com/docflow/cn/06-extract/tables.md): 详细说明文档抽取中的表格字段信息结构和处理方法
- [新建审核任务](https://docs-docflow.textin.com/docflow/cn/07-review/create_task.md): 通过 REST API 新建审核任务
- [获取审核结果](https://docs-docflow.textin.com/docflow/cn/07-review/get_result.md): 通过 REST API 获取审核任务结果并使用审核结果
- [快速启动](https://docs-docflow.textin.com/docflow/cn/07-review/quickstart.md): 了解如何在界面上使用智能审核功能
- [重试审核任务](https://docs-docflow.textin.com/docflow/cn/07-review/retry_task.md): 通过 REST API 重试审核任务或审核任务中的某条规则
- [规则库管理](https://docs-docflow.textin.com/docflow/cn/07-review/rule_management.md): 通过 REST API 管理审核规则库、规则组和规则
- [快速启动](https://docs-docflow.textin.com/docflow/cn/08-delete/quickstart.md): 参考示例，快速用API集成文档删除功能
- [快速启动](https://docs-docflow.textin.com/docflow/cn/09-retry/quickstart.md): 参考示例，快速用API集成文档重试功能
- [字段管理](https://docs-docflow.textin.com/docflow/cn/10-category-management/fields_management.md): 管理文件类别下的普通字段和表格字段
- [快速启动](https://docs-docflow.textin.com/docflow/cn/10-category-management/quickstart.md): 参考示例，快速用API集成文件类别管理功能
- [样本管理](https://docs-docflow.textin.com/docflow/cn/10-category-management/samples_management.md): 管理文件类别的样本文件
- [表格管理](https://docs-docflow.textin.com/docflow/cn/10-category-management/tables_management.md): 管理文件类别下的表格配置
- [前端 iframe 嵌入](https://docs-docflow.textin.com/docflow/cn/10-web/iframe.md): 在自有前端页面中通过 iframe 嵌入 DocFlow 页面，实现页面集成
- [中文类别参数传参问题](https://docs-docflow.textin.com/docflow/cn/100-faq/chinese_category_param.md): 解决中文或其他非英语类别名称在API传参时的问题
- [如何获取企业ID](https://docs-docflow.textin.com/docflow/cn/100-faq/get_enterprise_id.md)
- [如何获取工作空间ID](https://docs-docflow.textin.com/docflow/cn/100-faq/get_workspace_id.md)
- [OpenAPI 文件下载](https://docs-docflow.textin.com/docflow/cn/100-faq/openapi_download.md)
- [计费说明](https://docs-docflow.textin.com/docflow/cn/100-faq/product_charge.md)
- [如何配置文件类别](https://docs-docflow.textin.com/docflow/cn/100-faq/setup_category.md)
- [Python sdk](https://docs-docflow.textin.com/docflow/cn/11-sdk/python_sdk.md)
- [更新日志](https://docs-docflow.textin.com/docflow/cn/12-changelog/changelog.md): DocFlow API 文档更新记录
- [生成示例代码](https://docs-docflow.textin.com/docflow/cn/20-coding-guide/example-generate-code.md): 让 Agent 根据文档自动生成可用的 Docflow API 调用代码
- [检索文档和内容](https://docs-docflow.textin.com/docflow/cn/20-coding-guide/example-search-docs.md): 使用 Coding Agent 快速检索 TextIn Docflow 相关文档
- [安装 Coding Agent 工具](https://docs-docflow.textin.com/docflow/cn/20-coding-guide/install-coding-agent.md): 选择一款支持 MCP 的 AI Coding 工具
- [安装 Docflow 文档 MCP](https://docs-docflow.textin.com/docflow/cn/20-coding-guide/install-docflow-mcp.md): 连接 TextIn Docflow 文档 MCP 服务，让 Agent 获得文档检索能力
- [安装 Docflow 文档 Skill](https://docs-docflow.textin.com/docflow/cn/20-coding-guide/install-docflow-skill.md): 为 Coding Agent 安装 Docflow 文档 Skill，增强文档理解与代码生成能力
- [Coding Agent 接入概览](https://docs-docflow.textin.com/docflow/cn/20-coding-guide/intro.md): 帮助开发者快速将 TextIn Docflow 文档 Skill 接入 AI Coding Agent，实现智能文档检索与代码生成
- [快速开始](https://docs-docflow.textin.com/docflow/cn/20-coding-guide/quickstart.md): 三步完成 TextIn Docflow 文档 Skill 接入
- [智能文档抽取](https://docs-docflow.textin.com/xparse/entity-extraction.md): 调用 TextIn 智能文档抽取 API，从任意格式文档中一键提取结构化信息
- [获取目录树](https://docs-docflow.textin.com/xparse/parse-getcatalog.md)
- [获取图片并持久化](https://docs-docflow.textin.com/xparse/parse-getimage.md)
- [返回JSON结构说明](https://docs-docflow.textin.com/xparse/parse-getjson.md)
- [前端可视化：获取精确坐标](https://docs-docflow.textin.com/xparse/parse-getpos.md)
- [获取表格](https://docs-docflow.textin.com/xparse/parse-gettable.md)
- [多并发请求](https://docs-docflow.textin.com/xparse/parse-max-workers.md)
- [快速启动](https://docs-docflow.textin.com/xparse/parse-quickstart.md): 参考示例，快速将文档解析API接入到您的系统和应用流程中。

## OpenAPI Specs

- [openapi.bundle](https://docs-docflow.textin.com/docflow/ja/rest-api/openapi.bundle.yaml)
- [openapi](https://docs-docflow.textin.com/api-reference/openapi.json)