创建 PDF 处理任务 | 黑奴背锅文档中心

POST/openapi/v1/pdf/create_task

上传 PDF 并创建异步处理任务。单个任务上传文件总大小不能超过 100 MiB。

文件要求

除 merge 外，每个任务必须且只能上传一个 file PDF。
merge 使用重复的 file 或 files 字段上传 2-20 个 PDF，按上传顺序合并。
form_fill 还必须通过 data 上传一个 JSON 文件。

操作参数

trim 必须提供 pages。
watermark 必须提供 watermark_text。
encrypt 必须提供 owner_password。
pages 使用 pdfcpu 页面选择语法，例如 1-3,5、odd 或 even。

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

operation*string

要执行的 PDF 操作。

Value in

"validate"
"info"
"optimize"
"merge"
"split"
"trim"
"rotate"
"watermark"
"extract_images"
"form_fill"
"encrypt"
"decrypt"

file?file

PDF 文件；merge 时可重复提交该字段。

Formatbinary

files?array<>

merge 可使用的多文件字段。

Itemsitems <= 20

data?file

form_fill 操作所需的 JSON 表单数据文件。

Formatbinary

pages?string

页面选择；trim 必填，info、rotate、watermark、extract_images 可选。

rotation?integer

rotate 的旋转角度，必须是非零的 90 度整数倍。

Default90

span?integer

split 每份页数；0 表示按书签拆分。

Range0 <= value

Default1

watermark_text?string

watermark 必填的水印文字。

Lengthlength <= 1000

watermark_description?string

pdfcpu 水印样式描述。

Lengthlength <= 2000

on_top?boolean

是否将水印放在内容上层。

Defaultfalse

user_password?string

encrypt、decrypt 或读取受保护 PDF 时使用的用户密码。

Formatpassword

owner_password?string

encrypt 必填；decrypt 或读取受保护 PDF 时可选。

Formatpassword

Response Body

`application/json`

curl -X POST "https://example.com/openapi/v1/pdf/create_task" \  -F operation="validate"

{  "code": 0,  "message": "PDF 任务已进入队列",  "data": {    "task_id": "8dc4a3d8-38f0-4870-9794-62fd00ad04c2",    "operation": "optimize",    "status": "queued",    "status_url": "/openapi/v1/pdf/get_task?task_id=8dc4a3d8-38f0-4870-9794-62fd00ad04c2",    "result_url": "/openapi/v1/pdf/get_result?task_id=8dc4a3d8-38f0-4870-9794-62fd00ad04c2",    "input_bytes": 245760,    "max_concurrent": 2  },  "time": 1779502528}

Empty