Image 转 RTF API

通过 typed conversion 将图片转换为 RTF。

功能说明

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

调用方式

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

请求参数

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

Options 参数

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

参数名	类型	作用
enableOcr	Integer 或 String	是否使用 OCR。0 表示不开启，1 表示开启。
outputFileName	String	可选输出文件名。传入后会作为首选下载文件名。

请求示例

curl -X POST "http://localhost:8080/api/v1/process/img/rtf" \
  -H "x-api-key: your_api_key_here" \
  -F "[email protected]" \
  -F 'options={"enableOcr":0}'

响应

成功时返回转换后的文件流，响应头包含 Content-Type 和 Content-Disposition。如果转换失败，ComPDF Self-hosted 会返回接口错误码中定义的统一错误响应，其中包含 type、code、errorCode、message 和 traceId。