PDF 转 OFD API

通过 typed conversion route 将 PDF 文件转换为 OFD。

功能说明

ComPDF Self-hosted 提供同步文件流响应。该功能可以通过 ComPDF 请求地址调用，也可以直接调用转档接口。

调用方式

项目	值
认证	x-api-key: your_api_key_here
请求地址	POST http://localhost:8080/api/v1/process/pdf/ofd
请求类型	multipart/form-data
成功响应	OFD 文件流

请求参数

参数名	类型	说明	是否必填
file	File	源文件，建议扩展名：.pdf。	是
options	String	JSON 字符串，包含下方功能参数。	否
password	String	源文件打开密码，适用于受密码保护的 PDF。	否

Options 参数

以下字段放入 options JSON 字符串中。ComPDF Self-hosted 会解析 JSON，并在转发给转换引擎前做少量规范化。

参数名	类型	作用
isContainImg	Integer 或 String	转换结果中是否包含图像。0 表示不包含，1 表示包含。
isContainAnnot	Integer 或 String	转换结果中是否包含注释。0 表示不包含，1 表示包含。
enableOcr	Integer 或 String	是否使用 OCR。0 表示不开启，1 表示开启。
ocrRecognitionLang	String	OCR 识别语言。支持值：AUTO 自动、CHINESE 中文简体、CHINESE_TRAD 中文繁体、ENGLISH 英语、KOREAN 韩语、JAPANESE 日语、LATIN 拉丁语、DEVANAGARI 梵文、CYRILLIC 西里尔语、ARABIC 阿拉伯语、TAMIL 泰米尔语、TELUGU 泰卢固语、KANNADA 卡纳达语、THAI 泰语、GREEK 希腊语、ESLAV eslav 语系。默认值：AUTO。
ocrOption	String	INVALID_CHARACTER、SCAN_PAGE、INVALID_CHARACTERAND_SCAN_PAGE 或 ALL。默认值：ALL。
pageRanges	String	需要处理的页码范围，从 1 开始。示例：1、1-3、1,3-5。为空表示全部页面。
isOutputDocumentPerPage	Integer 或 String	是否每页输出为一个单独文档。0 表示否，1 表示是。
outputFileName	String	可选输出文件名。传入后会作为首选下载文件名。

请求示例

curl -X POST "http://localhost:8080/api/v1/process/pdf/ofd" \
  -H "x-api-key: your_api_key_here" \
  -F "[email protected]" \
  -F 'options={"isContainImg":1,"isContainAnnot":1,"enableOcr":0,"ocrRecognitionLang":"AUTO","ocrOption":"ALL","pageRanges":"","isOutputDocumentPerPage":0}'

响应

成功时返回转换后的文件流，响应头包含 Content-Type 和 Content-Disposition。如果转换失败，ComPDF Self-hosted 会返回统一错误 JSON。