PDF 转 JSON API

一次带鉴权的 POST 把公开 PDF URL 转成存储的结构化 JSON——类型化块、逐页文本和 Markdown,按页范围读回。

  • 单一 REST 端点
  • 类型化块 Schema
  • 双形态输出
  • 分页读取
  • 幂等的计费写入
  • 转换选项

请求示例

curl -X POST "https://api.agentbody.io/v1/documents/parse" \
  -H "Authorization: Bearer <YOUR_AGENTBODY_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{"analysis_chart":"true","file_name":"YOUR_FILE_NAME","file_url":"YOUR_FILE_URL","merge_tables":"true","recognize_seal":"true","relevel_titles":"true","return_span_boxes":"true"}'

响应示例

来自 OpenAPI 规范的已文档化响应。

Accepted document parse result reference.

{
  "document_id": "00000000-0000-4000-8000-000000000001",
  "get_path": "example_value",
  "pages": 1,
  "preview": "example_value"
}

功能特点

用 PDF to JSON API 搭建数据提取管线、文档索引和 LLM 摄取——URL 进,结构化块出。

单一 REST 端点

带 bearer API 密钥、file_url 和 file_name 调用 POST /v1/documents/parse。API 解析文档并存储结构化结果——无需托管解析库、无需维护排版引擎。

类型化块 Schema

结果中每块带 id、type、text、page 和 bbox——稳定、文档化的 schema。标题、段落等元素带标签到达,下游代码无需猜测即可分流。

双形态输出

存储结果同时携带程序用的 blocks 数组和阅读/提示词用的 Markdown 渲染——一次解析,同一个 document_id 服务提取管线和 LLM 上下文。

分页读取

通过 GET /v1/documents/{document_id} 携 page_start/page_end 读回结果。千页文档保持可查询;worker 分块处理而非一次无界响应。

幂等的计费写入

解析是按量计费操作。重试时带 Idempotency-Key 头,中断的响应不会重复计费同一文档——同键相同请求返回原始结果。

转换选项

逐次解析可调:merge_tables 合并碎片化表格单元,relevel_titles 规整标题层级——塑造 Markdown 的选项同样塑造块结构。

使用步骤

按以下步骤调用 PDF to JSON API:创建密钥,提交文档 URL,读回结构化块。

01

创建 API 密钥

创建 AgentBody 账号并在控制台生成 API 密钥。密钥留在服务端并以 bearer 令牌发送——绝不进浏览器代码。

02

提交文档

发送 POST /v1/documents/parse,带 file_url(公开 HTTPS)、file_name 和需要的转换选项。响应返回 document_id 和预览。

03

加幂等键

给每个可能重试的解析附 Idempotency-Key 头——超时、断连、worker 重启。同键相同请求返回原始结果,不重复计费。

04

读回块

携页码范围调用 GET /v1/documents/{document_id}。把 blocks 数组——id、type、text、page、bbox——直接解析进存储、索引或管线。

05

密钥留在服务端

从后端或定时任务调用端点。若用户触发转换,经你自己的端点代理,让密钥和计额掌控在你手里。

06

正确处理错误

400 修请求,401 配好密钥,402 充值余额,409 按文档化幂等键行为处理。502/503/504 带退避重试。

常见问题

PDF to JSON API 是什么?

一对带鉴权端点:POST /v1/documents/parse 把公开 PDF URL 转成存储的结构化结果,GET /v1/documents/{document_id} 读回——每元素带 id、type、text、page、bbox 的 blocks 数组,外加逐页文本和 Markdown。

PDF to JSON API 价格怎么算?

每次解析是消耗账号额度的按量计费操作。价格由网关管理——控制台查当前单价,用幂等键确保重试不双重计费。

每个 JSON 块里有什么?

五个字段:id(稳定元素标识)、type(标题/段落等元素类别)、text(内容)、page(页码)、bbox(页上坐标位置)。足以重建或查询文档结构。

能处理本地文件吗?

不能——API 接受公开 HTTPS file_url,不接受 multipart 上传。把 PDF 托管到 API 可达处(对象存储、公开桶)后传 URL。

超大的 PDF 怎么处理?

解析一次,然后携 page_start 和 page_end 分页读回。每次取回有界的块和页切片,千页文档分块处理,内存不爆。

怎么处理 API 错误?

400 修请求体,401 修 bearer 密钥,402 处理余额,409 按文档化幂等键行为处理。502/503/504 当暂时性上游故障,同键带退避重试。