通过

PDFco

PDF.co 是一组从数据提取到文档分析器的 PDF 工具。 生成 PDF、读取非结构化 PDF、填充 PDF 表单、将文本/图像添加到 PDF、拆分 PDF、合并 PDF、将 Pdf 表转换为 CSV、JSON、XML 等。

此连接器在以下产品和区域中可用：

服务 Class 区域
Copilot Studio 高级 除以下各项外的所有 Power Automate 区域 ：
     - 美国政府 （GCC）
     - 美国政府 （GCC High）
     - 由世纪互联运营的中国云
     - 美国国防部（DoD）
逻辑应用程序 标准 除以下各项外的所有 逻辑应用区域 ：
     - Azure 政府区域
     - Azure 中国区域
     - 美国国防部（DoD）
Power Apps 高级 除以下各项外的所有 Power Apps 区域 ：
     - 美国政府 （GCC）
     - 美国政府 （GCC High）
     - 由世纪互联运营的中国云
     - 美国国防部（DoD）
Power Automate 高级 除以下各项外的所有 Power Automate 区域 ：
     - 美国政府 （GCC）
     - 美国政府 （GCC High）
     - 由世纪互联运营的中国云
     - 美国国防部（DoD）
联系人​​
Name PDF.co 支持
URL https://support.bytescout.com
Email plugins@bytescout.com
连接器元数据
发布者 PDF.co
网站 https://pdf.co/
隐私策略 https://pdf.co/pages/legal/privacy
类别 生产力;数据

PDF.co 连接器提供合并 PDF、拆分 PDF、HTML 到 PDF 的作、PDF 到 PDF 的 URL 以及修改 PDF 的作。 合并 PDF 支持将不同类型的文档合并为 PDF 格式。 对于修改 PDF，它支持将文本/图像添加到 PDF，以及填写 PDF 表单。

先决条件

PDF.co 要求 API 密钥对其请求进行身份验证。

如何获取凭据

可以通过 注册 PDF.co 来获取 PDF.co API 密钥。

  • 登录到 PDF.co 帐户 https://app.pdf.co
  • 登录 API 密钥后，可在“查看 API 密钥”部分找到。

连接器入门

PDF.co 连接器由以下作组成。

  • HTML 到 PDF

    HTML 到 PDF 作将原始 HTML 转换为 PDF 格式。 此外，还可以配置高级选项，例如输出纸张大小、PDF 页面的方向、页边距、自定义页眉和页脚等。

  • 指向 PDF 的 URL

    顾名思义， URL 到 PDF 作会将网站 URL 转换为 PDF 文档。 我们可以为输出页边距、方向、页眉和页脚等配置高级设置。

  • 拆分 PDF

    此作是将输入 PDF 拆分为多个页面。 我们需要为需要多少个输出页指定“Pages”参数。

  • 合并 PDF

    此作将文档合并到 PDF 文件。 在这里，文档可以采用不同的格式，例如 pdf、doc、text、excel、zip 等。输入参数“URL”需要逗号分隔的文档 URL。

  • PDF 填充符

    PDF 填充符 作修改现有 PDF 文档。 使用此作时，我们可以将文本/图像添加到现有 PDF，并填写 PDF 表单字段。 我们必须以特定格式传递值。 有关详细信息，请访问 pdf.co 官方文档。

已知问题和限制

在此初始版本的 PDF.co 连接器中，只涵盖少量 PDF.co 功能。 此初始版本中缺少的功能之一是检查异步作业状态并获取已完成的作业结果。

常见错误和补救措施

  • 传递给 PDF.co作的输入 URL 必须是有效且可公开访问的 URL。

  • 如果 PDF.co 请求返回 401 - 未经授权的结果，请确保已提供有效的 PDF.co API 密钥。

  • 所有请求都会根据请求处理来扣除 PDF.co 信用额度。 因此，如果 PDF.co 帐户没有足够的信用额度，则会导致错误。

FAQ

有关所有 CA，请参阅 PDF.co 知识库 。

正在创建连接

连接器支持以下身份验证类型：
默认 用于创建连接的参数。 所有区域 不可共享

违约

适用：所有区域

用于创建连接的参数。

这是不可共享的连接。 如果 Power App 与另一个用户共享，系统会提示其他用户显式创建新连接。

Name 类型 Description 必选
API 密钥 securestring 此终结点的 API 密钥 True

限制

名称 调用 续订期
每个连接的 API 调用数 100 60 秒

操作

HTML 到 PDF

将 HTML 代码片段转换为功能齐全的 PDF。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/pdf-to-html/index.html 。
PDF 信息阅读器

获取有关 PDF 文档的详细信息，它是属性和安全权限。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/pdf-info-reader/index.html 。
PDF 删除安全性

从现有 PDF 文件中删除密码和安全性。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/password-and-security/index.html#post-tag-pdf-security-remove 。
PDF 删除页面

删除 PDF 中的页面。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/pdf-delete-pages/index.html 。
PDF 到 CSV

将 PDF 和扫描的图像转换为包含布局、列、行和表的 CSV 表示形式。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/pdf-to-csv/index.html 。
PDF 到 JPG

PDF 到 JPG 转换。 高质量渲染。 也适用于缩略图生成和预览。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/pdf-to-image/index.html#post-tag-pdf-convert-to-jpg 。
PDF 到 JSON

将 PDF 和扫描的图像转换为 JSON 表示形式，并保留文本、字体、图像、矢量和格式。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/pdf-to-json/index.html 。
PDF 到 JSON （AI Powered）

将 PDF 和扫描的图像转换为 JSON 表示形式，并保留文本、字体、图像、矢量和格式。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/pdf-to-json/index.html#post-tag-pdf-convert-to-json-meta 。
PDF 到 PNG

PDF 到 PNG 转换。 高质量渲染。 也适用于缩略图生成和预览。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/pdf-to-image/index.html#post-tag-pdf-convert-to-png 。
PDF 到 TIFF

PDF 到高质量的 TIFF 图像转换。 高质量渲染。 也适用于缩略图生成和预览。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/pdf-to-image/index.html#post-tag-pdf-convert-to-tiff 。
PDF 到 WEBP

PDF 到 WEBP 转换。 高质量渲染。 也适用于缩略图生成和预览。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/pdf-to-image/index.html#post-tag-pdf-convert-to-webp 。
PDF 到 XLS

将 PDF 和扫描的图像转换为保留布局和字体的电子表格。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/pdf-to-excel/index.html#post-tag-pdf-convert-to-xls 。
PDF 到 XLSX

将 PDF 和扫描的图像转换为保留布局和字体的电子表格。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/pdf-to-excel/index.html#post-tag-pdf-convert-to-xlsx 。
PDF 到 XML

将 PDF 转换为 XML，其中包含有关文本值、表格、字体、图像、对象位置的信息。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/pdf-to-xml/index.html 。
PDF 到扫描的 PDF

将 PDF 转换为扫描的 PDF。 结果 PDF 与打印并扫描 PDF 时相同。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/pdf-make-text-searchable-or-unsearchable/index.html#post-tag-pdf-makeunsearchable 。
PDF 压缩和优化

优化 PDF 文档以减小其大小。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/pdf-optimize/index.html 。
PDF 搜索和从 PDF 中删除文本

在 PDF 中搜索文本，并从 PDF 中删除找到的文本。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/pdf-search-and-delete-text/index.html 。
PDF 搜索和替换文本

通过搜索特定文本并将其替换为新文本来修改 PDF 文件。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/pdf-search-and-replace-text/index.html#post-tag-pdf-edit-replace-text 。
PDF 搜索并用图像替换文本

将 PDF 文档中的特定文本替换为图像。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/pdf-search-and-replace-text/index.html#post-tag-pdf-edit-replace-text-with-image 。
PDF 搜索文本

在 PDF 中搜索文本并获取坐标。 支持正则表达式。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/pdf-find/index.html 。
PDF 查找表

AI 提供支持的文档分析可以扫描文档以获取表，并返回页面上的表格数组，其中包含这些表中检测到的列的坐标和信息。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/pdf-find/index.html#post-tag-pdf-find-table 。
PDF 添加安全性

向现有 PDF 添加密码和安全限制。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/password-and-security/index.html#post-tag-pdf-security-add 。
PDF 窗体信息读取者

获取有关 PDF 表单文件中可填充字段的信息。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/pdf-forms-info-reader/index.html 。
PDF 转文本（不含布局和 ocr）

将 PDF 转换为纯文本，而不保留布局和 OCR 支持。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/pdf-to-text/index.html#post-tag-pdf-convert-to-text-simple 。
PDF 转文本（包含布局和 ocr）

将 PDF 图像和扫描的图像转换为保留布局的文本。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/pdf-to-text/index.html 。
PDF 附件提取

从输入 PDF 文档中提取附件。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/extract-attachments/index.html 。
使用附件发送电子邮件

使用附件发送电子邮件。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/email-send-and-decode/index.html 。
合并 PDF

将两个或多个 PDF 文件中的 PDF 合并为新的 PDF 文件。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/pdf-merge/index.html 。
合并 PDF （高级）

将两个或多个 pdf、doc、xls、图像中的 PDF 合并到新的 PDF 中，甚至将文档和图像压缩为新的 PDF。 支持 zip、doc、docx、xls、xlsx、rtf、txt、png、jpg。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/pdf-merge/index.html#post-tag-pdf-merge2 。
后台作业检查

检查以前使用 PDF.co API 创建的后台作业的状态。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/background-job-check/index.html 。
将扫描的 PDF 设置为文本可搜索

将 PDF 和扫描的 JPG、PNG 图像转换为文本可搜索的 PDF。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/pdf-make-text-searchable-or-unsearchable/index.html#post-tag-pdf-makesearchable 。
将文本、图像、窗体字段添加到 PDF

向 pdf 添加文本、图像、签名。 填写 PDF 表单字段，并从模板创建新的 PDF。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/pdf-add/index.html 。
拆分 PDF

使用页码和页范围将 PDF 文档中的页面拆分为多个新的 PDF 文件。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/pdf-split/index.html 。
拆分 PDF （高级）

通过文本搜索（支持正则表达式）或条形码将 PDF 拆分为多个 PDF 文件。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/pdf-split/index.html#post-tag-pdf-split2 。
指向 PDF 的 URL

从 URL 创建 PDF。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/pdf-from-url/index.html 。
文档分析器

文档分析器可以自动分析 PDF、JPG 和 PNG 文档，以从发票、语句、订单和其他 PDF 和扫描的文档中提取字段、表、值和条形码。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/document-parser/index.html 。
文档分类器

基于基于关键字的规则自动分类传入文档。 例如，可以定义规则来查找哪个供应商提供了相应文档来查找相应应用的模板。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/document-classifier/index.html 。
文档的 PDF（Doc、DocX、RTF、TXT、XPS）

将 DOC、DOCX、RTF、TXT、XPS 文件转换为 PDF。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/pdf-from-document/index.html#post-tag-pdf-convert-from-doc 。
旋转 PDF 页面

旋转 PDF 页面。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/pdf-rotate-pages/index.html 。
旋转 PDF 页面 （自动）

使用 AI 根据文本分析自动修复扫描 PDF 中页面的旋转。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/pdf-rotate-pages/index.html#post-tag-pdf-edit-rotate-auto 。
条形码生成器

生成高质量的条形码图像。 支持 QR 码、Datamatrix、Code 39、Code 128、PDF417 和其他许多条形码类型。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/barcode-generator/index.html 。
条形码阅读器

从图像和 PDF 读取条形码。 可以从 QR 码和代码 128、EAN 到 Datamatrix、PDF417、GS1 和许多其他条形码读取所有常用条形码类型。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/barcode-reader/index.html 。
来自 CSV 的 PDF

将 CSV 文档转换为 PDF。 也适用于 XLS 或 XLSX 输入。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/pdf-from-document/index.html#post-tag-pdf-convert-from-csv 。
来自图像的 PDF

从一个或多个 JPG、PNG、TIFF 图像创建 PDF 文件。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/pdf-from-image/index.html 。
来自电子表格的 PDF

从 XLS、XLSX 电子表格创建 PDF。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/convert-excel/index.html#post-tag-xls-convert-to-pdf 。
来自电子邮件的 PDF

将电子邮件文件（MSG 或 EML）代码转换为 PDF。 从输入电子邮件中提取附件（如果有），并将其作为 pdf 附件嵌入 PDF。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/pdf-from-email/index.html 。
电子表格到 CSV

将 XLS/XLSX 转换为 CSV 逗号分隔值文件。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/convert-excel/index.html#post-tag-xls-convert-to-csv 。
电子表格到 HTML

将 XLS/XLSX 转换为 HTML 文件。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/convert-excel/index.html#post-tag-xls-convert-to-html 。
电子表格到 JSON

将 XLS/XLSX 转换为 JSON 文件。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/convert-excel/index.html#post-tag-xls-convert-to-json 。
电子表格到 TXT

将 XLS/XLSX 或 CSV 转换为文本文件。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/convert-excel/index.html#post-tag-xls-convert-to-txt 。
电子表格到 XML

将 XLS/XLSX 或 CSV 转换为 XML 文件。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/convert-excel/index.html#post-tag-xls-convert-to-xml 。
电子邮件信息

获取电子邮件信息，例如发件人/收件人、主题、正文等。有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/email-send-and-decode/index.html#post-tag-email-decode 。
电子邮件附件提取

使用基本电子邮件信息提取电子邮件附件。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/email-send-and-decode/index.html#post-tag-email-extract-attachments 。

HTML 到 PDF

操作 ID:
HtmlToPdf

将 HTML 代码片段转换为功能齐全的 PDF。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/pdf-to-html/index.html 。

参数

名称 密钥 必需 类型 说明
HTML
 html True html

要转换的输入 HTML 代码。
Name
 name string

新 PDF 文件的基文件名。
边距
 margins string

使用自定义值替代默认边距（订单为 top right bottom left）。 你可以设置所有边距： 10px， 5mm， 5in 用于所有边距。
纸张大小
 paperSize string

选择 PDF 纸张大小。 可以是字母、法律、小报、账本、A0、A1、A2、A3、A4、A5、A6 或自定义大小。 自定义大小可以设置为 px（像素）、mm 或（英寸），宽度和高度用空格分隔，如下所示：200 300、200px 300px、200mm 300mm、20cm 30 厘米或 6 英寸 8 英寸。
方向
 orientation string

PDF 页面方向。
打印背景
 printBackground boolean

启用或禁用文档背景打印
Header
 header html

设置为 HTML，以便在页眉的每个页面上应用标头。
页脚
 footer html

设置为 HTML，以便在底部的每一页上应用页脚。
过期日期
 expiration integer

设置输出链接的过期时间（默认值为 60 分钟或 1 小时），在此指定的持续时间后，将从 PDF.co 临时文件存储中删除任何生成的输出文件（s）。 链接过期的最大持续时间因当前订阅计划而异。
Profiles
 profiles string

此参数可用于设置用于微调的其他配置，并启用更多选项。 请访问 PDF.co 知识库（https://developer.pdf.co/api/profiles/index.html）了解配置文件示例等。
异步
 async boolean

对于在后台运行的长进程，API 将返回一个 jobId，与 JobCheck 终结点一起使用以检查进程状态并检索输出，而你可以继续执行其他任务，而无需等待此过程完成。

返回

名称 路径 类型 说明
URL
 url string

输出文档 URL。
作业 ID
 jobId string

jobId
页计数
 pageCount integer

输出文档中的页数。
错误
 error boolean

指示作是否成功。
状态代码
 status integer

HTTP 响应的状态代码
Name
 name string

输出文档名称
贷项
 credits integer

用于此请求的 PDF.co 信用额度
持续时间
 duration integer

请求执行持续时间
剩余额度
 remainingCredits integer

PDF.co 帐户剩余额度

PDF 信息阅读器

操作 ID:
PDFInfoReader

获取有关 PDF 文档的详细信息，它是属性和安全权限。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/pdf-info-reader/index.html 。

参数

名称 密钥 必需 类型 说明
URL
 url True string

源文件的 URL。 支持 Google Drive、Dropbox 和 PDF.co 内置文件存储的链接。
异步
 async boolean

对于在后台运行的长进程，API 将返回一个 jobId，与 JobCheck 模块一起使用以检查进程状态并检索输出，而你可以继续执行其他任务，而无需等待此过程完成。
密码
 password string

PDF 文件的密码
Profiles
 profiles string

使用此参数可设置用于微调和额外选项的其他配置，浏览 PDF.co 知识库（https://developer.pdf.co/api/profiles/index.html）以获取配置文件示例。

返回

名称 路径 类型 说明
JobId
 jobId string

jobId
URL
 url string

网址
PageCount
 info.PageCount integer

PageCount
作者
 info.Author string

作者
Title
 info.Title string

Title
Producer
 info.Producer string

Producer
Subject
 info.Subject string

Subject
CreationDate
 info.CreationDate string

CreationDate
Bookmarks
 info.Bookmarks string

Bookmarks
关键字
 info.Keywords string

关键字
Creator
 info.Creator string

Creator
已加密
 info.Encrypted boolean

已加密
PasswordProtected
 info.PasswordProtected boolean

PasswordProtected
为空
 info.PageRectangle.Location.IsEmpty boolean

为空
info.PageRectangle.Location.X float

X
info.PageRectangle.Location.Y float

Y
尺寸
 info.PageRectangle.Size string

尺寸
info.PageRectangle.X float

X
info.PageRectangle.Y float

Y
info.PageRectangle.Width float

宽度
info.PageRectangle.Height float

高度
info.PageRectangle.Left float

Left
info.PageRectangle.Top float

Top
info.PageRectangle.Right float

正确
info.PageRectangle.Bottom float

向下
为空
 info.PageRectangle.IsEmpty boolean

为空
ModificationDate
 info.ModificationDate string

ModificationDate
AttachmentCount (附件数量)
 info.AttachmentCount integer

AttachmentCount (附件数量)
EncryptionAlgorithm
 info.EncryptionAlgorithm string

EncryptionAlgorithm
PermissionPrinting
 info.PermissionPrinting boolean

PermissionPrinting
PermissionModifyDocument
 info.PermissionModifyDocument boolean

PermissionModifyDocument
PermissionContentExtraction
 info.PermissionContentExtraction boolean

PermissionContentExtraction
PermissionModifyAnnotations
 info.PermissionModifyAnnotations boolean

PermissionModifyAnnotations
PermissionFillForms
 info.PermissionFillForms boolean

PermissionFillForms
PermissionAccessibility
 info.PermissionAccessibility boolean

PermissionAccessibility
PermissionAssemble
 info.PermissionAssemble boolean

PermissionAssemble
PermissionHighQualityPrint
 info.PermissionHighQualityPrint boolean

PermissionHighQualityPrint
错误
 error boolean

错误
状态
 status integer

状态
贷项
 credits integer

积分
剩余额度
 remainingCredits integer

remainingCredits
持续时间
 duration integer

duration

PDF 删除安全性

操作 ID:
PDFSecurityRemove

从现有 PDF 文件中删除密码和安全性。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/password-and-security/index.html#post-tag-pdf-security-remove 。

参数

名称 密钥 必需 类型 说明
URL
 url True string

源文件的 URL。 支持 Google Drive、Dropbox 和 PDF.co 内置文件存储的链接。
密码
 password True string

用于打开文件并删除安全功能的所有者/用户密码。
Name
 name string

生成的输出的文件名。
过期日期
 expiration integer

设置输出链接的过期时间（默认值为 60 分钟或 1 小时），在此指定的持续时间后，将从 PDF.co 临时文件存储中删除任何生成的输出文件（s）。 链接过期的最大持续时间因当前订阅计划而异。
异步
 async boolean

对于在后台运行的长进程，API 将返回一个 jobId，与 JobCheck 终结点一起使用以检查进程状态并检索输出，而你可以继续执行其他任务，而无需等待此过程完成。
Profiles
 profiles string

可以使用此参数设置其他和额外的选项，以便设置自定义配置。 浏览 PDF.co 知识库（https://developer.pdf.co/api/profiles/index.html）了解配置文件示例。

返回

名称 路径 类型 说明
URL
 url string
作业 ID
 jobId string

jobId
页计数
 pageCount integer

pageCount
错误
 error boolean

错误
状态
 status integer

状态
Name
 name string

姓名
贷项
 credits integer

积分
剩余额度
 remainingCredits integer

remainingCredits
持续时间
 duration integer

duration

PDF 删除页面

操作 ID:
PDFDeletePages

删除 PDF 中的页面。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/pdf-delete-pages/index.html 。

参数

名称 密钥 必需 类型 说明
URL
 url True string

源文件的 URL。 支持 Google Drive、Dropbox 和 PDF.co 内置文件存储的链接。
页
 pages string

要处理的页索引（或范围）的逗号分隔列表。 第一页从 0 开始（零）。 若要设置范围，请使用短划线 -，例如：0,2-5,7-。 若要将索引范围设置为最后一页，请使用如下所示的范围：2- （从第 3 页开始，索引从零开始，直到文档开始）。 对于 ALL 页面，只需将此参数留空。 示例：0,2-5,7 - 表示第一页，第 3 页到第 6 页，然后从第 8 页（索引 = 7）页到文档末尾的范围。
Name
 name string

生成的输出的文件名
过期日期
 expiration integer

设置输出链接的过期时间（默认值为 60 分钟或 1 小时），在此指定的持续时间后，将从 PDF.co 临时文件存储中删除任何生成的输出文件（s）。 链接过期的最大持续时间因当前订阅计划而异。
Profiles
 profiles string

使用此参数可设置用于微调和额外选项的其他配置。 浏览 PDF.co 知识库（https://developer.pdf.co/api/profiles/index.html）了解配置文件示例。
异步
 async boolean

对于在后台运行的长进程，API 将返回一个 jobId，可用于 JobCheck 终结点检查进程的状态并检索输出，同时你可以继续执行其他任务，而无需等待此过程完成。

返回

名称 路径 类型 说明
URL
 url string

网址
作业 ID
 jobId string

jobId
页计数
 pageCount integer

pageCount
错误
 error boolean

错误
状态
 status integer

状态
Name
 name string

姓名
贷项
 credits integer

积分
剩余额度
 remainingCredits integer

remainingCredits
持续时间
 duration integer

duration

PDF 到 CSV

操作 ID:
PDFToCSV

将 PDF 和扫描的图像转换为包含布局、列、行和表的 CSV 表示形式。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/pdf-to-csv/index.html 。

参数

名称 密钥 必需 类型 说明
URL
 url True string

源文件的 URL。 支持 Google Drive、Dropbox 和 PDF.co 内置文件存储的链接。
OCR 语言
 lang string

设置 OCR（图像中的文本）的语言，以便在提取文本时用于扫描的 PDF、PNG 和 JPG 文档输入。 默认值为“eng”。 还支持其他语言：deu、spa、chi_sim、jpn 和其他许多语言（此处提供了支持的 OCR 语言https://developer.pdf.co/api/pdf-make-text-searchable-or-unsearchable/index.html#language-support的完整列表）。 还可以同时使用 2 种语言，如下所示：eng+deu 或 jpn+kor（任意组合）。
内联
 inline boolean
解开
 unwrap string

启用 lineGrouping 时，将行解包到表格单元格中的单个行中。
页
 pages string

要处理的页索引（或范围）的逗号分隔列表。 第一页从 0 开始（零）。 若要设置范围，请使用短划线 -，例如：0,2-5,7-。 若要将索引范围设置为最后一页，请使用如下所示的范围：2- （从第 3 页开始，索引从零开始，直到文档开始）。 对于 ALL 页面，只需将此参数留空。 示例：0,2-5,7 - 表示第一页，第 3 页到第 6 页，然后从第 8 页（索引 = 7）页到文档末尾的范围。
矩形
 rect string

定义用于提取的坐标，例如 51.8、114.8、235.5、204.0。 使用 PDF.co PDF 编辑添加帮助程序 （https://app.pdf.co/pdf-edit-add-helper） 获取或测量 pdf 坐标。
异步
 async boolean

对于在后台运行的长进程，API 将返回一个 jobId，与 JobCheck 终结点一起使用以检查进程状态并检索输出，而你可以继续执行其他任务，而无需等待此过程完成。
Name
 name string

生成的输出的文件名
行分组
 lineGrouping string

表格单元格中的行分组。 设置为 1 以启用分组。
过期日期
 expiration integer

设置输出链接的过期时间（默认值为 60 分钟或 1 小时），在此指定的持续时间后，将从 PDF.co 临时文件存储中删除任何生成的输出文件（s）。 链接过期的最大持续时间因当前订阅计划而异。
Profiles
 profiles string

此参数可用于设置用于微调的其他配置，并启用更多选项。 请访问 PDF.co 知识库（https://developer.pdf.co/api/profiles/index.html）了解配置文件示例等。

返回

名称 路径 类型 说明
Body
 body string

身体
URL
 url string

网址
作业 ID
 jobId string

jobId
错误
 error boolean

错误
状态
 status integer

状态
Name
 name string

姓名
贷项
 credits integer

积分
remainingCredits
 remainingCredits integer

remainingCredits
持续时间
 duration integer

duration

PDF 到 JPG

操作 ID:
PDFToJPG

PDF 到 JPG 转换。 高质量渲染。 也适用于缩略图生成和预览。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/pdf-to-image/index.html#post-tag-pdf-convert-to-jpg 。

参数

名称 密钥 必需 类型 说明
URL
 url True string

源文件的 URL。 支持 Google Drive、Dropbox 和 PDF.co 内置文件存储的链接。
内联的
 inline boolean

内联的
页
 pages string

要处理的页索引（或范围）的逗号分隔列表。 第一页从 0 开始（零）。 若要设置范围，请使用短划线 -，例如：0,2-5,7-。 若要将索引范围设置为最后一页，请使用如下所示的范围：2- （从第 3 页开始，索引从零开始，直到文档开始）。 对于 ALL 页面，只需将此参数留空。 示例：0,2-5,7 - 表示第一页，第 3 页到第 6 页，然后从第 8 页（索引 = 7）页到文档末尾的范围。
矩形
 rect string

定义用于提取的坐标，例如 51.8、114.8、235.5、204.0。 使用 PDF.co PDF 编辑添加帮助程序 （https://app.pdf.co/pdf-edit-add-helper） 获取或测量 pdf 坐标。
过期日期
 expiration integer

设置输出链接的过期时间（默认值为 60 分钟或 1 小时），在此指定的持续时间后，将从 PDF.co 临时文件存储中删除任何生成的输出文件（s）。 链接过期的最大持续时间因当前订阅计划而异。
异步
 async boolean

对于在后台运行的长进程，API 将返回一个 jobId，与 JobCheck 终结点一起使用以检查进程状态并检索输出，而你可以继续执行其他任务，而无需等待此过程完成。
Profiles
 profiles string

可以使用此参数设置其他和额外的选项，以便设置自定义配置。 浏览 PDF.co 知识库（https://developer.pdf.co/api/profiles/index.html）了解配置文件示例。

返回

名称 路径 类型 说明
网址
 urls array of string

网址
作业 ID
 jobId string

jobId
页计数
 pageCount integer

pageCount
错误
 error boolean

错误
状态
 status integer

状态
Name
 name string

姓名
贷项
 credits integer

积分
剩余额度
 remainingCredits integer

remainingCredits
持续时间
 duration integer

duration

PDF 到 JSON

操作 ID:
PDFToJSON

将 PDF 和扫描的图像转换为 JSON 表示形式，并保留文本、字体、图像、矢量和格式。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/pdf-to-json/index.html 。

参数

名称 密钥 必需 类型 说明
URL
 url True string

源文件的 URL。 支持 Google Drive、Dropbox 和 PDF.co 内置文件存储的链接。
OCR 语言
 lang string

设置 OCR（图像中的文本）的语言，以便在提取文本时用于扫描的 PDF、PNG 和 JPG 文档输入。 默认值为“eng”。 还支持其他语言：deu、spa、chi_sim、jpn 和其他许多语言（此处提供了支持的 OCR 语言https://developer.pdf.co/api/pdf-make-text-searchable-or-unsearchable/index.html#language-support的完整列表）。 还可以同时使用 2 种语言，如下所示：eng+deu 或 jpn+kor（任意组合）。
内联
 inline boolean
解开
 unwrap string

启用 lineGrouping 时，将行解包到表格单元格中的单个行中。
页
 pages string

要处理的页索引（或范围）的逗号分隔列表。 第一页从 0 开始（零）。 若要设置范围，请使用短划线 -，例如：0,2-5,7-。 若要将索引范围设置为最后一页，请使用如下所示的范围：2- （从第 3 页开始，索引从零开始，直到文档开始）。 对于 ALL 页面，只需将此参数留空。 示例：0,2-5,7 - 表示第一页，第 3 页到第 6 页，然后从第 8 页（索引 = 7）页到文档末尾的范围。
矩形
 rect string

定义用于提取的坐标，例如 51.8、114.8、235.5、204.0。 使用 PDF.co PDF 编辑添加帮助程序 （https://app.pdf.co/pdf-edit-add-helper） 获取或测量 pdf 坐标。
异步
 async boolean

对于在后台运行的长进程，API 将返回一个 jobId，与 JobCheck 终结点一起使用以检查进程状态并检索输出，而你可以继续执行其他任务，而无需等待此过程完成。
Name
 name string

生成的输出的文件名
行分组
 lineGrouping string

表格单元格中的行分组。 设置为 1 以启用分组。
过期日期
 expiration integer

设置输出链接的过期时间（默认值为 60 分钟或 1 小时），在此指定的持续时间后，将从 PDF.co 临时文件存储中删除任何生成的输出文件（s）。 链接过期的最大持续时间因当前订阅计划而异。
Profiles
 profiles string

此参数可用于设置用于微调的其他配置，并启用更多选项。 请访问 PDF.co 知识库（https://developer.pdf.co/api/profiles/index.html）了解配置文件示例等。

返回

名称 路径 类型 说明
Body
 body object

身体
URL
 url string

网址
作业 ID
 jobId string

jobId
页计数
 pageCount integer

pageCount
错误
 error boolean

错误
状态
 status integer

状态
Name
 name string

姓名
贷项
 credits integer

积分
remainingCredits
 remainingCredits integer

remainingCredits
持续时间
 duration integer

duration

PDF 到 JSON （AI Powered）

操作 ID:
PDFToJSONMeta

将 PDF 和扫描的图像转换为 JSON 表示形式，并保留文本、字体、图像、矢量和格式。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/pdf-to-json/index.html#post-tag-pdf-convert-to-json-meta 。

参数

名称 密钥 必需 类型 说明
URL
 url True string

源文件的 URL。 支持 Google Drive、Dropbox 和 PDF.co 内置文件存储的链接。
OCR 语言
 lang string

设置 OCR（图像中的文本）的语言，以便在提取文本时用于扫描的 PDF、PNG 和 JPG 文档输入。 默认值为“eng”。 还支持其他语言：deu、spa、chi_sim、jpn 和其他许多语言（此处提供了支持的 OCR 语言https://developer.pdf.co/api/pdf-make-text-searchable-or-unsearchable/index.html#language-support的完整列表）。 还可以同时使用 2 种语言，如下所示：eng+deu 或 jpn+kor（任意组合）。
内联
 inline boolean
解开
 unwrap string

启用 lineGrouping 时，将行解包到表格单元格中的单个行中。
页
 pages string

要处理的页索引（或范围）的逗号分隔列表。 第一页从 0 开始（零）。 若要设置范围，请使用短划线 -，例如：0,2-5,7-。 若要将索引范围设置为最后一页，请使用如下所示的范围：2- （从第 3 页开始，索引从零开始，直到文档开始）。 对于 ALL 页面，只需将此参数留空。 示例：0,2-5,7 - 表示第一页，第 3 页到第 6 页，然后从第 8 页（索引 = 7）页到文档末尾的范围。
矩形
 rect string

定义用于提取的坐标，例如 51.8、114.8、235.5、204.0。 使用 PDF.co PDF 编辑添加帮助程序 （https://app.pdf.co/pdf-edit-add-helper） 获取或测量 pdf 坐标。
异步
 async boolean

对于在后台运行的长进程，API 将返回一个 jobId，与 JobCheck 终结点一起使用以检查进程状态并检索输出，而你可以继续执行其他任务，而无需等待此过程完成。
Name
 name string

生成的输出的文件名
行分组
 lineGrouping string

表格单元格中的行分组。 设置为 1 以启用分组。
过期日期
 expiration integer

设置输出链接的过期时间（默认值为 60 分钟或 1 小时），在此指定的持续时间后，将从 PDF.co 临时文件存储中删除任何生成的输出文件（s）。 链接过期的最大持续时间因当前订阅计划而异。
Profiles
 profiles string

此参数可用于设置用于微调的其他配置，并启用更多选项。 请访问 PDF.co 知识库（https://developer.pdf.co/api/profiles/index.html）了解配置文件示例等。

返回

名称 路径 类型 说明
Body
 body object

身体
URL
 url string

网址
作业 ID
 jobId string

jobId
页计数
 pageCount integer

pageCount
错误
 error boolean

错误
状态
 status integer

状态
Name
 name string

姓名
贷项
 credits integer

积分
remainingCredits
 remainingCredits integer

remainingCredits
持续时间
 duration integer

duration

PDF 到 PNG

操作 ID:
PDFToPNG

PDF 到 PNG 转换。 高质量渲染。 也适用于缩略图生成和预览。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/pdf-to-image/index.html#post-tag-pdf-convert-to-png 。

参数

名称 密钥 必需 类型 说明
URL
 url True string

源文件的 URL。 支持 Google Drive、Dropbox 和 PDF.co 内置文件存储的链接。
内联的
 inline boolean

内联的
页
 pages string

要处理的页索引（或范围）的逗号分隔列表。 第一页从 0 开始（零）。 若要设置范围，请使用短划线 -，例如：0,2-5,7-。 若要将索引范围设置为最后一页，请使用如下所示的范围：2- （从第 3 页开始，索引从零开始，直到文档开始）。 对于 ALL 页面，只需将此参数留空。 示例：0,2-5,7 - 表示第一页，第 3 页到第 6 页，然后从第 8 页（索引 = 7）页到文档末尾的范围。
矩形
 rect string

定义用于提取的坐标，例如 51.8、114.8、235.5、204.0。 使用 PDF.co PDF 编辑添加帮助程序 （https://app.pdf.co/pdf-edit-add-helper） 获取或测量 pdf 坐标。
过期日期
 expiration integer

设置输出链接的过期时间（默认值为 60 分钟或 1 小时），在此指定的持续时间后，将从 PDF.co 临时文件存储中删除任何生成的输出文件（s）。 链接过期的最大持续时间因当前订阅计划而异。
异步
 async boolean

对于在后台运行的长进程，API 将返回一个 jobId，与 JobCheck 终结点一起使用以检查进程状态并检索输出，而你可以继续执行其他任务，而无需等待此过程完成。
Profiles
 profiles string

可以使用此参数设置其他和额外的选项，以便设置自定义配置。 浏览 PDF.co 知识库（https://developer.pdf.co/api/profiles/index.html）了解配置文件示例。

返回

名称 路径 类型 说明
网址
 urls array of string

网址
作业 ID
 jobId string

jobId
页计数
 pageCount integer

pageCount
错误
 error boolean

错误
状态
 status integer

状态
Name
 name string

姓名
贷项
 credits integer

积分
剩余额度
 remainingCredits integer

remainingCredits
持续时间
 duration integer

duration

PDF 到 TIFF

操作 ID:
PDFToTIFF

PDF 到高质量的 TIFF 图像转换。 高质量渲染。 也适用于缩略图生成和预览。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/pdf-to-image/index.html#post-tag-pdf-convert-to-tiff 。

参数

名称 密钥 必需 类型 说明
URL
 url True string

源文件的 URL。 支持 Google Drive、Dropbox 和 PDF.co 内置文件存储的链接。
内联的
 inline boolean

内联的
页
 pages string

要处理的页索引（或范围）的逗号分隔列表。 第一页从 0 开始（零）。 若要设置范围，请使用短划线 -，例如：0,2-5,7-。 若要将索引范围设置为最后一页，请使用如下所示的范围：2- （从第 3 页开始，索引从零开始，直到文档开始）。 对于 ALL 页面，只需将此参数留空。 示例：0,2-5,7 - 表示第一页，第 3 页到第 6 页，然后从第 8 页（索引 = 7）页到文档末尾的范围。
矩形
 rect string

定义用于提取的坐标，例如 51.8、114.8、235.5、204.0。 使用 PDF.co PDF 编辑添加帮助程序 （https://app.pdf.co/pdf-edit-add-helper） 获取或测量 pdf 坐标。
过期日期
 expiration integer

设置输出链接的过期时间（默认值为 60 分钟或 1 小时），在此指定的持续时间后，将从 PDF.co 临时文件存储中删除任何生成的输出文件（s）。 链接过期的最大持续时间因当前订阅计划而异。
异步
 async boolean

对于在后台运行的长进程，API 将返回一个 jobId，与 JobCheck 终结点一起使用以检查进程状态并检索输出，而你可以继续执行其他任务，而无需等待此过程完成。
Profiles
 profiles string

可以使用此参数设置其他和额外的选项，以便设置自定义配置。 浏览 PDF.co 知识库（https://developer.pdf.co/api/profiles/index.html）了解配置文件示例。

返回

名称 路径 类型 说明
URL
 url string
作业 ID
 jobId string

jobId
页计数
 pageCount integer

pageCount
错误
 error boolean

错误
状态
 status integer

状态
Name
 name string

姓名
贷项
 credits integer

积分
剩余额度
 remainingCredits integer

remainingCredits
持续时间
 duration integer

duration

PDF 到 WEBP

操作 ID:
PDFToWEBP

PDF 到 WEBP 转换。 高质量渲染。 也适用于缩略图生成和预览。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/pdf-to-image/index.html#post-tag-pdf-convert-to-webp 。

参数

名称 密钥 必需 类型 说明
URL
 url True string

源文件的 URL。 支持 Google Drive、Dropbox 和 PDF.co 内置文件存储的链接。
内联的
 inline boolean

内联的
页
 pages string

要处理的页索引（或范围）的逗号分隔列表。 第一页从 0 开始（零）。 若要设置范围，请使用短划线 -，例如：0,2-5,7-。 若要将索引范围设置为最后一页，请使用如下所示的范围：2- （从第 3 页开始，索引从零开始，直到文档开始）。 对于 ALL 页面，只需将此参数留空。 示例：0,2-5,7 - 表示第一页，第 3 页到第 6 页，然后从第 8 页（索引 = 7）页到文档末尾的范围。
矩形
 rect string

定义用于提取的坐标，例如 51.8、114.8、235.5、204.0。 使用 PDF.co PDF 编辑添加帮助程序 （https://app.pdf.co/pdf-edit-add-helper） 获取或测量 pdf 坐标。
过期日期
 expiration integer

设置输出链接的过期时间（默认值为 60 分钟或 1 小时），在此指定的持续时间后，将从 PDF.co 临时文件存储中删除任何生成的输出文件（s）。 链接过期的最大持续时间因当前订阅计划而异。
异步
 async boolean

对于在后台运行的长进程，API 将返回一个 jobId，与 JobCheck 终结点一起使用以检查进程状态并检索输出，而你可以继续执行其他任务，而无需等待此过程完成。
Profiles
 profiles string

可以使用此参数设置其他和额外的选项，以便设置自定义配置。 浏览 PDF.co 知识库（https://developer.pdf.co/api/profiles/index.html）了解配置文件示例。

返回

名称 路径 类型 说明
网址
 urls array of string

网址
作业 ID
 jobId string

jobId
页计数
 pageCount integer

pageCount
错误
 error boolean

错误
状态
 status integer

状态
Name
 name string

姓名
贷项
 credits integer

积分
剩余额度
 remainingCredits integer

remainingCredits
持续时间
 duration integer

duration

PDF 到 XLS

操作 ID:
PDFToXLS

将 PDF 和扫描的图像转换为保留布局和字体的电子表格。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/pdf-to-excel/index.html#post-tag-pdf-convert-to-xls 。

参数

名称 密钥 必需 类型 说明
URL
 url True string

源文件的 URL。 支持 Google Drive、Dropbox 和 PDF.co 内置文件存储的链接。
OCR 语言
 lang string

设置 OCR（图像中的文本）的语言，以便在提取文本时用于扫描的 PDF、PNG 和 JPG 文档输入。 默认值为“eng”。 还支持其他语言：deu、spa、chi_sim、jpn 和其他许多语言（此处提供了支持的 OCR 语言https://developer.pdf.co/api/pdf-make-text-searchable-or-unsearchable/index.html#language-support的完整列表）。 还可以同时使用 2 种语言，如下所示：eng+deu 或 jpn+kor（任意组合）。
解开
 unwrap string

启用 lineGrouping 时，将行解包到表格单元格中的单个行中。
页
 pages string

要处理的页索引（或范围）的逗号分隔列表。 第一页从 0 开始（零）。 若要设置范围，请使用短划线 -，例如：0,2-5,7-。 若要将索引范围设置为最后一页，请使用如下所示的范围：2- （从第 3 页开始，索引从零开始，直到文档开始）。 对于 ALL 页面，只需将此参数留空。 示例：0,2-5,7 - 表示第一页，第 3 页到第 6 页，然后从第 8 页（索引 = 7）页到文档末尾的范围。
矩形
 rect string

定义用于提取的坐标，例如 51.8、114.8、235.5、204.0。 使用 PDF.co PDF 编辑添加帮助程序 （https://app.pdf.co/pdf-edit-add-helper） 获取或测量 pdf 坐标。
异步
 async boolean

对于在后台运行的长进程，API 将返回一个 jobId，与 JobCheck 终结点一起使用以检查进程状态并检索输出，而你可以继续执行其他任务，而无需等待此过程完成。
Name
 name string

生成的输出的文件名
行分组
 lineGrouping string

表格单元格中的行分组。 设置为 1 以启用分组。
过期日期
 expiration integer

设置输出链接的过期时间（默认值为 60 分钟或 1 小时），在此指定的持续时间后，将从 PDF.co 临时文件存储中删除任何生成的输出文件（s）。 链接过期的最大持续时间因当前订阅计划而异。
Profiles
 profiles string

此参数可用于设置用于微调的其他配置，并启用更多选项。 请访问 PDF.co 知识库（https://developer.pdf.co/api/profiles/index.html）了解配置文件示例等。

返回

名称 路径 类型 说明
URL
 url string

网址
作业 ID
 jobId string

jobId
页计数
 pageCount integer

pageCount
错误
 error boolean

错误
状态
 status integer

状态
Name
 name string

姓名
贷项
 credits integer

积分
remainingCredits
 remainingCredits integer

remainingCredits
持续时间
 duration integer

duration

PDF 到 XLSX

操作 ID:
PDFToXLSX

将 PDF 和扫描的图像转换为保留布局和字体的电子表格。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/pdf-to-excel/index.html#post-tag-pdf-convert-to-xlsx 。

参数

名称 密钥 必需 类型 说明
URL
 url True string

源文件的 URL。 支持 Google Drive、Dropbox 和 PDF.co 内置文件存储的链接。
OCR 语言
 lang string

设置 OCR（图像中的文本）的语言，以便在提取文本时用于扫描的 PDF、PNG 和 JPG 文档输入。 默认值为“eng”。 还支持其他语言：deu、spa、chi_sim、jpn 和其他许多语言（此处提供了支持的 OCR 语言https://developer.pdf.co/api/pdf-make-text-searchable-or-unsearchable/index.html#language-support的完整列表）。 还可以同时使用 2 种语言，如下所示：eng+deu 或 jpn+kor（任意组合）。
解开
 unwrap string

启用 lineGrouping 时，将行解包到表格单元格中的单个行中。
页
 pages string

要处理的页索引（或范围）的逗号分隔列表。 第一页从 0 开始（零）。 若要设置范围，请使用短划线 -，例如：0,2-5,7-。 若要将索引范围设置为最后一页，请使用如下所示的范围：2- （从第 3 页开始，索引从零开始，直到文档开始）。 对于 ALL 页面，只需将此参数留空。 示例：0,2-5,7 - 表示第一页，第 3 页到第 6 页，然后从第 8 页（索引 = 7）页到文档末尾的范围。
矩形
 rect string

定义用于提取的坐标，例如 51.8、114.8、235.5、204.0。 使用 PDF.co PDF 编辑添加帮助程序 （https://app.pdf.co/pdf-edit-add-helper） 获取或测量 pdf 坐标。
异步
 async boolean

对于在后台运行的长进程，API 将返回一个 jobId，与 JobCheck 终结点一起使用以检查进程状态并检索输出，而你可以继续执行其他任务，而无需等待此过程完成。
Name
 name string

生成的输出的文件名
行分组
 lineGrouping string

表格单元格中的行分组。 设置为 1 以启用分组。
过期日期
 expiration integer

设置输出链接的过期时间（默认值为 60 分钟或 1 小时），在此指定的持续时间后，将从 PDF.co 临时文件存储中删除任何生成的输出文件（s）。 链接过期的最大持续时间因当前订阅计划而异。
Profiles
 profiles string

此参数可用于设置用于微调的其他配置，并启用更多选项。 请访问 PDF.co 知识库（https://developer.pdf.co/api/profiles/index.html）了解配置文件示例等。

返回

名称 路径 类型 说明
URL
 url string

网址
作业 ID
 jobId string

jobId
页计数
 pageCount integer

pageCount
错误
 error boolean

错误
状态
 status integer

状态
Name
 name string

姓名
贷项
 credits integer

积分
remainingCredits
 remainingCredits integer

remainingCredits
持续时间
 duration integer

duration

PDF 到 XML

操作 ID:
PDFToXML

将 PDF 转换为 XML，其中包含有关文本值、表格、字体、图像、对象位置的信息。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/pdf-to-xml/index.html 。

参数

名称 密钥 必需 类型 说明
URL
 url True string

源文件的 URL。 支持 Google Drive、Dropbox 和 PDF.co 内置文件存储的链接。
内联
 inline boolean
OCR 语言
 lang string

设置 OCR（图像中的文本）的语言，以便在提取文本时用于扫描的 PDF、PNG 和 JPG 文档输入。 默认值为“eng”。 还支持其他语言：deu、spa、chi_sim、jpn 和其他许多语言（此处提供了支持的 OCR 语言https://developer.pdf.co/api/pdf-make-text-searchable-or-unsearchable/index.html#language-support的完整列表）。 还可以同时使用 2 种语言，如下所示：eng+deu 或 jpn+kor（任意组合）。
解开
 unwrap string

启用 lineGrouping 时，将行解包到表格单元格中的单个行中。
页
 pages string

要处理的页索引（或范围）的逗号分隔列表。 第一页从 0 开始（零）。 若要设置范围，请使用短划线 -，例如：0,2-5,7-。 若要将索引范围设置为最后一页，请使用如下所示的范围：2- （从第 3 页开始，索引从零开始，直到文档开始）。 对于 ALL 页面，只需将此参数留空。 示例：0,2-5,7 - 表示第一页，第 3 页到第 6 页，然后从第 8 页（索引 = 7）页到文档末尾的范围。
矩形
 rect string

定义用于提取的坐标，例如 51.8、114.8、235.5、204.0。 使用 PDF.co PDF 编辑添加帮助程序 （https://app.pdf.co/pdf-edit-add-helper） 获取或测量 pdf 坐标。
异步
 async boolean

对于在后台运行的长进程，API 将返回一个 jobId，与 JobCheck 终结点一起使用以检查进程状态并检索输出，而你可以继续执行其他任务，而无需等待此过程完成。
Name
 name string

生成的输出的文件名
行分组
 lineGrouping string

表格单元格中的行分组。 设置为 1 以启用分组。
过期日期
 expiration integer

设置输出链接的过期时间（默认值为 60 分钟或 1 小时），在此指定的持续时间后，将从 PDF.co 临时文件存储中删除任何生成的输出文件（s）。 链接过期的最大持续时间因当前订阅计划而异。
Profiles
 profiles string

此参数可用于设置用于微调的其他配置，并启用更多选项。 请访问 PDF.co 知识库（https://developer.pdf.co/api/profiles/index.html）了解配置文件示例等。

返回

名称 路径 类型 说明
URL
 url string

网址
Body
 body string

身体
作业 ID
 jobId string

jobId
页计数
 pageCount integer

pageCount
错误
 error boolean

错误
状态
 status integer

状态
Name
 name string

姓名
贷项
 credits integer

积分
remainingCredits
 remainingCredits integer

remainingCredits
持续时间
 duration integer

duration

PDF 到扫描的 PDF

操作 ID:
PDFUnSearchable

将 PDF 转换为扫描的 PDF。 结果 PDF 与打印并扫描 PDF 时相同。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/pdf-make-text-searchable-or-unsearchable/index.html#post-tag-pdf-makeunsearchable 。

参数

名称 密钥 必需 类型 说明
URL
 url True string

源文件的 URL。 支持 Google Drive、Dropbox 和 PDF.co 内置文件存储的链接。
页
 pages string

要处理的页索引（或范围）的逗号分隔列表。 第一页从 0 开始（零）。 若要设置范围，请使用短划线 -，例如：0,2-5,7-。 若要将索引范围设置为最后一页，请使用如下所示的范围：2- （从第 3 页开始，索引从零开始，直到文档开始）。 对于 ALL 页面，只需将此参数留空。 示例：0,2-5,7 - 表示第一页，第 3 页到第 6 页，然后从第 8 页（索引 = 7）页到文档末尾的范围。
密码
 password string

PDF 文件的密码
异步
 async boolean

对于在后台运行的长进程，将 Async 设置为 true，API 将返回一个 jobId，与 JobCheck 模块一起使用以检查进程的状态并检索输出，而你可以继续执行其他任务，而无需等待此过程完成。
Profiles
 profiles string

使用此参数可设置用于微调和额外选项的其他配置。 浏览 PDF.co 知识库（https://developer.pdf.co/api/profiles/index.html）了解配置文件示例。

返回

名称 路径 类型 说明
URL
 url string

网址
作业 ID
 jobId string

jobId
页计数
 pageCount integer

pageCount
错误
 error boolean

错误
状态
 status integer

状态
贷项
 credits integer

积分
剩余额度
 remainingCredits integer

remainingCredits
持续时间
 duration integer

duration

PDF 压缩和优化

操作 ID:
PDFCompress

优化 PDF 文档以减小其大小。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/pdf-optimize/index.html 。

参数

名称 密钥 必需 类型 说明
URL
 url True string

源文件的 URL。 支持 Google Drive、Dropbox 和 PDF.co 内置文件存储的链接。
Name
 name string

生成的输出的文件名
过期日期
 expiration integer

设置输出链接的过期时间（默认值为 60 分钟或 1 小时），在此指定的持续时间后，将从 PDF.co 临时文件存储中删除任何生成的输出文件（s）。 链接过期的最大持续时间因当前订阅计划而异。
密码
 password string

PDF 文件的密码
Profiles
 profiles string

使用此参数可设置用于微调和额外选项的其他配置。 浏览 PDF.co 知识库（https://developer.pdf.co/api/profiles/index.html）了解配置文件示例。
异步
 async boolean

对于在后台运行的长进程，API 将返回一个 jobId，可用于 JobCheck 终结点检查进程的状态并检索输出，同时你可以继续执行其他任务，而无需等待此过程完成。

返回

名称 路径 类型 说明
URL
 url string

网址
作业 ID
 jobId string

jobId
页计数
 pageCount integer

pageCount
错误
 error boolean

错误
状态
 status integer

状态
Name
 name string

姓名
贷项
 credits integer

积分
剩余额度
 remainingCredits integer

remainingCredits
持续时间
 duration integer

duration

PDF 搜索和从 PDF 中删除文本

操作 ID:
SearchAndDeleteText

在 PDF 中搜索文本，并从 PDF 中删除找到的文本。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/pdf-search-and-delete-text/index.html 。

参数

名称 密钥 必需 类型 说明
URL
 url True string

源文件的 URL。 支持 Google Drive、Dropbox 和 PDF.co 内置文件存储的链接。
searchStrings
 searchStrings True array of string

searchStrings
区分大小写
 caseSensitive boolean
是否已启用正则表达式？
 regex boolean

设置为 true 以对搜索字符串使用正则表达式。
替换限制
 replacementLimit integer

限制每个项目的搜索数和替换项数。 默认值为 0，这意味着无限制的搜索和替换，因此将替换每个找到的匹配项。
过期日期
 expiration integer

设置输出链接的过期时间（默认值为 60 分钟或 1 小时），在此指定的持续时间后，将从 PDF.co 临时文件存储中删除任何生成的输出文件（s）。 链接过期的最大持续时间因当前订阅计划而异。
Name
 name string

生成的输出的文件名
密码
 password string

PDF 文件的密码
页
 pages string

要处理的页索引（或范围）的逗号分隔列表。 第一页从 0 开始（零）。 若要设置范围，请使用短划线 -，例如：0,2-5,7-。 若要将索引范围设置为最后一页，请使用如下所示的范围：2- （从第 3 页开始，索引从零开始，直到文档开始）。 对于 ALL 页面，只需将此参数留空。 示例：0,2-5,7 - 表示第一页，第 3 页到第 6 页，然后从第 8 页（索引 = 7）页到文档末尾的范围。
Profiles
 profiles string

使用此参数可设置用于微调和额外选项的其他配置。 浏览 PDF.co 知识库（https://developer.pdf.co/api/profiles/index.html）了解配置文件示例。
异步
 async boolean

对于在后台运行的长进程，API 将返回一个 jobId，可用于 JobCheck 终结点检查进程的状态并检索输出，同时你可以继续执行其他任务，而无需等待此过程完成。

返回

名称 路径 类型 说明
URL
 url string

网址
作业 ID
 jobId string

jobId
页计数
 pageCount integer

pageCount
错误
 error boolean

错误
状态
 status integer

状态
Name
 name string

姓名
贷项
 credits integer

积分
剩余额度
 remainingCredits integer

remainingCredits
持续时间
 duration integer

duration

PDF 搜索和替换文本

操作 ID:
SearchAndReplace

通过搜索特定文本并将其替换为新文本来修改 PDF 文件。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/pdf-search-and-replace-text/index.html#post-tag-pdf-edit-replace-text 。

参数

名称 密钥 必需 类型 说明
URL
 url True string

源文件的 URL。 支持 Google Drive、Dropbox 和 PDF.co 内置文件存储的链接。
searchStrings
 searchStrings True array of string

搜索字符串
replaceStrings
 replaceStrings array of string

替换字符串
区分大小写？
 caseSensitive boolean
替换限制
 replacementLimit integer

限制每个项目的搜索数和替换项数。 默认值为 0，这意味着无限制的搜索和替换，因此将替换每个找到的匹配项。
是否已启用正则表达式？
 regex boolean

设置为 true 以对搜索字符串使用正则表达式。
页
 pages string

要处理的页索引（或范围）的逗号分隔列表。 第一页从 0 开始（零）。 若要设置范围，请使用短划线 -，例如：0,2-5,7-。 若要将索引范围设置为最后一页，请使用如下所示的范围：2- （从第 3 页开始，索引从零开始，直到文档开始）。 对于 ALL 页面，只需将此参数留空。 示例：0,2-5,7 - 表示第一页，第 3 页到第 6 页，然后从第 8 页（索引 = 7）页到文档末尾的范围。
密码
 password string

PDF 文件的密码
Name
 name string

生成的输出的文件名
过期日期
 expiration integer

设置输出链接的过期时间（默认值为 60 分钟或 1 小时），在此指定的持续时间后，将从 PDF.co 临时文件存储中删除任何生成的输出文件（s）。 链接过期的最大持续时间因当前订阅计划而异。
异步
 async boolean

对于在后台运行的长进程，API 将返回一个 jobId，与 JobCheck 模块一起使用以检查进程状态并检索输出，而你可以继续执行其他任务，而无需等待此过程完成。

返回

名称 路径 类型 说明
URL
 url string

网址
页计数
 pageCount integer
作业 ID
 jobId string

jobId
错误
 error boolean

错误
状态
 status integer

状态
Name
 name string

姓名
贷项
 credits integer

积分
剩余额度
 remainingCredits integer

remainingCredits
持续时间
 duration integer

PDF 搜索并用图像替换文本

操作 ID:
SearchAndReplaceWithImage

将 PDF 文档中的特定文本替换为图像。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/pdf-search-and-replace-text/index.html#post-tag-pdf-edit-replace-text-with-image 。

参数

名称 密钥 必需 类型 说明
URL
 url True string

源文件的 URL。 支持 Google Drive、Dropbox 和 PDF.co 内置文件存储的链接。
区分大小写
 caseSensitive boolean
搜索字符串
 searchString True string

单个文本替换。 要替换的单词或短语
替换图像 URL
 replaceImage True string

要插入文档中的图像 URL。
页
 pages string

要处理的页索引（或范围）的逗号分隔列表。 第一页从 0 开始（零）。 若要设置范围，请使用短划线 -，例如：0,2-5,7-。 若要将索引范围设置为最后一页，请使用如下所示的范围：2- （从第 3 页开始，索引从零开始，直到文档开始）。 对于 ALL 页面，只需将此参数留空。 示例：0,2-5,7 - 表示第一页，第 3 页到第 6 页，然后从第 8 页（索引 = 7）页到文档末尾的范围。
是异步
 async boolean

对于在后台运行的长进程，API 将返回一个 jobId，与作业检查模块一起使用以检查进程状态并检索输出，而你可以继续执行其他任务，而无需等待此过程完成。
是否已启用正则表达式？
 regex boolean
替换限制
 replacementLimit integer

限制每个项目的搜索数和替换项数。 默认值为 0，这意味着无限制的搜索和替换，因此将替换每个找到的匹配项。
过期日期
 expiration integer

设置输出链接的过期时间（默认值为 60 分钟或 1 小时），在此指定的持续时间后，将从 PDF.co 临时文件存储中删除任何生成的输出文件（s）。 链接过期的最大持续时间因当前订阅计划而异。
密码
 password string

PDF 文件的密码

返回

名称 路径 类型 说明
作业 ID
 jobId string

jobId
URL
 url string

网址
页计数
 pageCount integer

pageCount
错误
 error boolean

错误
状态
 status integer

状态
Name
 name string

姓名
贷项
 credits integer

积分
剩余额度
 remainingCredits integer

remainingCredits
持续时间
 duration integer

duration

PDF 搜索文本

操作 ID:
PDFSerarchText

在 PDF 中搜索文本并获取坐标。 支持正则表达式。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/pdf-find/index.html 。

参数

名称 密钥 必需 类型 说明
URL
 url True string

源文件的 URL。 支持 Google Drive、Dropbox 和 PDF.co 内置文件存储的链接。
搜索字符串
 searchString True string

如果将“正则表达式搜索”参数设置为 true，则搜索的文本可以支持正则表达式。
正则表达式搜索
 regexSearch boolean
页
 pages string

要处理的页索引（或范围）的逗号分隔列表。 重要说明：第一页从 0 开始（零）。 若要设置范围，请使用短划线 -，例如：0,2-5,7-。 若要将一个范围从索引设置为最后一页，请使用如下所示的范围：2- （从第 #3 页开始，索引从零开始，直到文档开始），所有页面只保留此参数为空。 示例：0,2-5,7 - 表示第一页，第三页到第六页，然后从第 8 页（索引 = 7）页到文档末尾的范围，输入必须采用字符串格式。
内联
 inline boolean
Word 匹配模式
 wordMatchingMode string

值可以是“SmartMatch”、“ExactMatch”或“None”。
密码
 password string

PDF 文件的密码
异步
 async boolean

对于在后台运行的长进程，API 将返回一个 jobId，与 JobCheck 模块一起使用以检查进程状态并检索输出，而你可以继续执行其他任务，而无需等待此过程完成。
Profiles
 profiles string

使用此参数可设置用于微调和额外选项的其他配置。 浏览 PDF.co 知识库（https://developer.pdf.co/api/profiles/index.html）了解配置文件示例。

返回

名称 路径 类型 说明
身体
 body array of object

身体
文本
 body.text string

文本消息
Left
 body.left float

左边
Top
 body.top float

top
宽度
 body.width float

width
高度
 body.height float

身高
页面索引
 body.pageIndex integer

pageIndex
URL
 url string

网址
作业 ID
 jobId string
页计数
 pageCount integer

pageCount
错误
 error boolean

错误
状态
 status integer

状态
贷项
 credits integer

积分
剩余额度
 remainingCredits integer

remainingCredits
持续时间
 duration integer

duration

PDF 查找表

操作 ID:
PDFFindTable

AI 提供支持的文档分析可以扫描文档以获取表，并返回页面上的表格数组，其中包含这些表中检测到的列的坐标和信息。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/pdf-find/index.html#post-tag-pdf-find-table 。

参数

名称 密钥 必需 类型 说明
URL
 url True string

源文件的 URL。 支持 Google Drive、Dropbox 和 PDF.co 内置文件存储的链接。
页
 pages string

要处理的页索引（或范围）的逗号分隔列表。 重要说明：第一页从 0 开始（零）。 若要设置范围，请使用短划线 -，例如：0,2-5,7-。 若要将索引范围设置为最后一页，请使用如下所示的范围：2- （从第 3 页开始，索引从零开始，直到文档开始）。 对于 ALL 页面，只需将此参数留空。 示例：0,2-5,7 - 表示第一页，第 3 页到第 6 页，然后从第 8 页（索引 = 7）页到文档末尾的范围。
内联
 inline boolean
密码
 password string

PDF 文件的密码
Profiles
 profiles string

使用此参数可设置用于微调和额外选项的其他配置。 浏览 PDF.co 知识库（https://developer.pdf.co/api/profiles/index.html）了解配置文件示例。
过期日期
 expiration integer

设置输出链接的过期时间（默认值为 60 分钟或 1 小时），在此指定的持续时间后，将从 PDF.co 临时文件存储中删除任何生成的输出文件（s）。 链接过期的最大持续时间因当前订阅计划而异。
异步
 async boolean

对于在后台运行的长进程，API 将返回一个 jobId，与 /job/check 终结点一起使用以检查进程的状态并检索输出，同时你可以继续执行其他任务，而无需等待此过程完成。

返回

名称 路径 类型 说明
作业 ID
 jobId string

jobId
URL
 url string

网址
tables
 body.tables array of object

tables
PageIndex
 body.tables.PageIndex integer

PageIndex
body.tables.X float

X
Y
 body.tables.Y float

Y
宽度
 body.tables.Width float

宽度
body.tables.Height float

高度
列
 body.tables.Columns array of float

列
矩形
 body.tables.rect string

矩形
页计数
 pageCount integer

pageCount
错误
 error boolean

错误
状态
 status integer

状态
贷项
 credits integer

贷项
剩余额度
 remainingCredits integer

remainingCredits
持续时间
 duration integer

duration

PDF 添加安全性

操作 ID:
PDFAddSecurity

向现有 PDF 添加密码和安全限制。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/password-and-security/index.html#post-tag-pdf-security-add 。

参数

名称 密钥 必需 类型 说明
URL
 url True string

源文件的 URL。 支持 Google Drive、Dropbox 和 PDF.co 内置文件存储的链接。
所有者密码
 ownerPassword True string

用于文档加密和设置/删除限制的主所有者密码。
用户密码
 userPassword string

需要可选的用户密码才能查看和打印文档。
加密算法
 encryptionAlgorithm string

加密算法。 有效值：RC4_40bit、RC4_128bit、AES_128bit、AES_256bit。 建议AES_128bit或更高版本
允许辅助功能支持
 allowAccessibilitySupport boolean

允许或禁止出于辅助功能需求提取内容。 注意：输入 userPassword（如果有）时，此限制适用。 如果用户输入所有者密码，则此限制不适用。
允许程序集文档
 allowAssemblyDocument boolean

允许或禁止组合文档。 注意：输入 userPassword（如果有）时，此限制适用。 如果用户输入所有者密码，则此限制不适用。
允许打印文档
 allowPrintDocument boolean

允许或禁止打印 PDF 文档。 注意：输入 userPassword（如果有）时，此限制适用。 如果用户输入所有者密码，则此限制不适用。
允许填充表单
 allowFillForms boolean

允许或禁止在 PDF 文档中填写交互式表单字段（包括签名字段）。 注意：输入 userPassword（如果有）时，此限制适用。 如果用户输入所有者密码，则此限制不适用。
允许修改文档
 allowModifyDocument boolean

允许或禁止修改 PDF 文档。 注意：输入 userPassword（如果有）时，此限制适用。 如果用户输入所有者密码，则此限制不适用。
允许内容提取
 allowContentExtraction boolean

允许或禁止从 PDF 文档复制内容。 注意：输入 userPassword（如果有）时，此限制适用。 如果用户输入所有者密码，则此限制不适用。
允许修改批注
 allowModifyAnnotations boolean

允许或禁止与 PDF 文档中的文本批注和表单进行交互。 注意：输入 userPassword（如果有）时，此限制适用。 如果用户输入所有者密码，则此限制不适用。
打印质量
 printQuality string

允许打印质量。 有效值：HighResolution、LowResolution。 注意：输入 userPassword（如果有）时，此限制适用。 如果用户输入所有者密码，则此限制不适用。
Name
 name string

生成的输出的文件名。
过期日期
 expiration integer

设置输出链接的过期时间（默认值为 60 分钟或 1 小时），在此指定的持续时间后，将从 PDF.co 临时文件存储中删除任何生成的输出文件（s）。 链接过期的最大持续时间因当前订阅计划而异。
异步
 async boolean

对于在后台运行的长进程，API 将返回一个 jobId，与 JobCheck 终结点一起使用以检查进程状态并检索输出，而你可以继续执行其他任务，而无需等待此过程完成。
Profiles
 profiles string

可以使用此参数设置其他和额外的选项，以便设置自定义配置。 浏览 PDF.co 知识库（https://developer.pdf.co/api/profiles/index.html）了解配置文件示例。

返回

名称 路径 类型 说明
URL
 url string
作业 ID
 jobId string

jobId
页计数
 pageCount integer

pageCount
错误
 error boolean

错误
状态
 status integer

状态
Name
 name string

姓名
贷项
 credits integer

积分
剩余额度
 remainingCredits integer

remainingCredits
持续时间
 duration integer

duration

PDF 窗体信息读取者

操作 ID:
PDFFormsInfoReader

获取有关 PDF 表单文件中可填充字段的信息。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/pdf-forms-info-reader/index.html 。

参数

名称 密钥 必需 类型 说明
URL
 url True string

源文件的 URL。 支持 Google Drive、Dropbox 和 PDF.co 内置文件存储的链接。
异步
 async boolean

对于在后台运行的长进程，API 将返回一个 jobId，与 JobCheck 模块一起使用以检查进程状态并检索输出，而你可以继续执行其他任务，而无需等待此过程完成。
密码
 password string

PDF 文件的密码
Profiles
 profiles string

使用此参数可设置用于微调和额外选项的其他配置，浏览 PDF.co 知识库（https://developer.pdf.co/api/profiles/index.html）以获取配置文件示例。

返回

名称 路径 类型 说明
JobId
 jobId string

jobId
URL
 url string

网址
PageCount
 info.PageCount integer

PageCount
作者
 info.Author string

作者
Title
 info.Title string

Title
Producer
 info.Producer string

Producer
Subject
 info.Subject string

Subject
CreationDate
 info.CreationDate string

CreationDate
Bookmarks
 info.Bookmarks string

Bookmarks
关键字
 info.Keywords string

关键字
Creator
 info.Creator string

Creator
已加密
 info.Encrypted boolean

已加密
PasswordProtected
 info.PasswordProtected boolean

PasswordProtected
为空
 info.PageRectangle.Location.IsEmpty boolean

为空
X
 info.PageRectangle.Location.X float

X
Y
 info.PageRectangle.Location.Y float

Y
尺寸
 info.PageRectangle.Size string

尺寸
X
 info.PageRectangle.X float

X
Y
 info.PageRectangle.Y float

Y
宽度
 info.PageRectangle.Width float

宽度
info.PageRectangle.Height float

高度
info.PageRectangle.Left float

Left
Top
 info.PageRectangle.Top float

Top
正确
 info.PageRectangle.Right float

正确
info.PageRectangle.Bottom float

向下
为空
 info.PageRectangle.IsEmpty boolean

为空
ModificationDate
 info.ModificationDate string

ModificationDate
附件计数
 info.AttachmentCount integer

AttachmentCount (附件数量)
EncryptionAlgorithm
 info.EncryptionAlgorithm string

EncryptionAlgorithm
PermissionPrinting
 info.PermissionPrinting boolean

PermissionPrinting
PermissionModifyDocument
 info.PermissionModifyDocument boolean

PermissionModifyDocument
PermissionContentExtraction
 info.PermissionContentExtraction boolean

PermissionContentExtraction
PermissionModifyAnnotations
 info.PermissionModifyAnnotations boolean

PermissionModifyAnnotations
PermissionFillForms
 info.PermissionFillForms boolean

PermissionFillForms
PermissionAccessibility
 info.PermissionAccessibility boolean

PermissionAccessibility
PermissionAssemble
 info.PermissionAssemble boolean

PermissionAssemble
PermissionHighQualityPrint
 info.PermissionHighQualityPrint boolean

PermissionHighQualityPrint
CustomProperties
 info.CustomProperties array of object

CustomProperties
Key
 info.CustomProperties.Key string

Key
价值
 info.CustomProperties.Value string

价值
Fields
 info.FieldsInfo.Fields array of object

Fields
PageIndex
 info.FieldsInfo.Fields.PageIndex integer

PageIndex
类型
 info.FieldsInfo.Fields.Type string

类型
FieldName
 info.FieldsInfo.Fields.FieldName string

FieldName
AltFieldName
 info.FieldsInfo.Fields.AltFieldName string

AltFieldName
价值
 info.FieldsInfo.Fields.Value string

价值
Left
 info.FieldsInfo.Fields.Left float

Left
Top
 info.FieldsInfo.Fields.Top float

Top
宽度
 info.FieldsInfo.Fields.Width float

宽度
高度
 info.FieldsInfo.Fields.Height float

高度
错误
 error boolean

错误
状态
 status integer

状态
贷项
 credits integer

积分
剩余额度
 remainingCredits integer

remainingCredits
持续时间
 duration integer

duration

PDF 转文本（不含布局和 ocr）

操作 ID:
PDFToTextSimple

将 PDF 转换为纯文本，而不保留布局和 OCR 支持。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/pdf-to-text/index.html#post-tag-pdf-convert-to-text-simple 。

参数

名称 密钥 必需 类型 说明
URL
 url True string

源文件的 URL。 支持 Google Drive、Dropbox 和 PDF.co 内置文件存储的链接。
内联
 inline boolean
页
 pages string

要处理的页索引（或范围）的逗号分隔列表。 第一页从 0 开始（零）。 若要设置范围，请使用短划线 -，例如：0,2-5,7-。 若要将索引范围设置为最后一页，请使用如下所示的范围：2- （从第 3 页开始，索引从零开始，直到文档开始）。 对于 ALL 页面，只需将此参数留空。 示例：0,2-5,7 - 表示第一页，第 3 页到第 6 页，然后从第 8 页（索引 = 7）页到文档末尾的范围。
异步
 async boolean

对于在后台运行的长进程，API 将返回一个 jobId，与 JobCheck 终结点一起使用以检查进程状态并检索输出，而你可以继续执行其他任务，而无需等待此过程完成。
Name
 name string

生成的输出的文件名
过期日期
 expiration integer

设置输出链接的过期时间（默认值为 60 分钟或 1 小时），在此指定的持续时间后，将从 PDF.co 临时文件存储中删除任何生成的输出文件（s）。 链接过期的最大持续时间因当前订阅计划而异。

返回

名称 路径 类型 说明
Body
 body string

身体
URL
 url string

网址
作业 ID
 jobId string

jobId
页计数
 pageCount integer

pageCount
错误
 error boolean

错误
状态
 status integer

状态
Name
 name string

姓名
贷项
 credits integer

积分
remainingCredits
 remainingCredits integer

remainingCredits
持续时间
 duration integer

duration

PDF 转文本（包含布局和 ocr）

操作 ID:
PDFToText

将 PDF 图像和扫描的图像转换为保留布局的文本。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/pdf-to-text/index.html 。

参数

名称 密钥 必需 类型 说明
URL
 url True string

源文件的 URL。 支持 Google Drive、Dropbox 和 PDF.co 内置文件存储的链接。
OCR 语言
 lang string

设置 OCR（图像中的文本）的语言，以便在提取文本时用于扫描的 PDF、PNG 和 JPG 文档输入。 默认值为“eng”。 还支持其他语言：deu、spa、chi_sim、jpn 和其他许多语言（此处提供了支持的 OCR 语言https://developer.pdf.co/api/pdf-make-text-searchable-or-unsearchable/index.html#language-support的完整列表）。 还可以同时使用 2 种语言，如下所示：eng+deu 或 jpn+kor（任意组合）。
内联
 inline boolean
解开
 unwrap string

启用 lineGrouping 时，将行解包到表格单元格中的单个行中。
页
 pages string

要处理的页索引（或范围）的逗号分隔列表。 第一页从 0 开始（零）。 若要设置范围，请使用短划线 -，例如：0,2-5,7-。 若要将索引范围设置为最后一页，请使用如下所示的范围：2- （从第 3 页开始，索引从零开始，直到文档开始）。 对于 ALL 页面，只需将此参数留空。 示例：0,2-5,7 - 表示第一页，第 3 页到第 6 页，然后从第 8 页（索引 = 7）页到文档末尾的范围。
矩形
 rect string

定义用于提取的坐标，例如 51.8、114.8、235.5、204.0。 使用 PDF.co PDF 编辑添加帮助程序 （https://app.pdf.co/pdf-edit-add-helper） 获取或测量 pdf 坐标。
异步
 async boolean

对于在后台运行的长进程，API 将返回一个 jobId，与 JobCheck 终结点一起使用以检查进程状态并检索输出，而你可以继续执行其他任务，而无需等待此过程完成。
Name
 name string

生成的输出的文件名
行分组
 lineGrouping string

表格单元格中的行分组。 设置为 1 以启用分组。
过期日期
 expiration integer

设置输出链接的过期时间（默认值为 60 分钟或 1 小时），在此指定的持续时间后，将从 PDF.co 临时文件存储中删除任何生成的输出文件（s）。 链接过期的最大持续时间因当前订阅计划而异。
Profiles
 profiles string

此参数可用于设置用于微调的其他配置，并启用更多选项。 请访问 PDF.co 知识库（https://developer.pdf.co/api/profiles/index.html）了解配置文件示例等。

返回

名称 路径 类型 说明
Body
 body string

身体
URL
 url string

网址
作业 ID
 jobId string

jobId
页计数
 pageCount integer

pageCount
错误
 error boolean

错误
状态
 status integer

状态
Name
 name string

姓名
贷项
 credits integer

积分
remainingCredits
 remainingCredits integer

remainingCredits
持续时间
 duration integer

duration

PDF 附件提取

操作 ID:
PDFAttachmentExtraction

从输入 PDF 文档中提取附件。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/extract-attachments/index.html 。

参数

名称 密钥 必需 类型 说明
URL
 url True string

源 PDF 文档的 URL
内联
 inline boolean

确定是否在响应中返回输出或链接到输出文件。
Name
 name string

新 PDF 文件的基文件名
过期日期
 expiration integer

设置输出链接的过期时间（默认值为 60 分钟或 1 小时），在此指定的持续时间后，将从 PDF.co 临时文件存储中删除任何生成的输出文件（s）。 链接过期的最大持续时间因当前订阅计划而异。
Profiles
 profiles string

使用此参数可设置用于微调和额外选项的其他配置。 浏览 PDF.co 知识库（https://developer.pdf.co/api/profiles/index.html）了解配置文件示例。
异步
 async boolean

创建后台处理作业。

返回

名称 路径 类型 说明
网址
 urls array of string

网址
URL
 url string

输出文档 URL。
作业 ID
 jobId string

jobId
计数
 pageCount integer

输出文档中的页数。
错误
 error boolean

指示作是否成功。
状态
 status integer

HTTP 响应的状态代码
Name
 name string

输出文档名称
贷项
 credits integer

用于此请求的 PDF.co 信用额度
持续时间
 duration integer

请求执行持续时间
剩余额度
 remainingCredits integer

PDF.co 帐户剩余额度

使用附件发送电子邮件

操作 ID:
EmailSend

使用附件发送电子邮件。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/email-send-and-decode/index.html 。

参数

名称 密钥 必需 类型 说明
URL
 url True string

源文件的 URL。 支持 Google Drive、Dropbox 和 PDF.co 内置文件存储的链接。
来自
 from True string

包含发件人名称和电子邮件的“发件人”字段。 示例：John Doe john@example.com
到
 to True string

包含接收方名称和电子邮件的“收件人”字段。 示例：合作伙伴 partner@example.com
Subject
 subject True string

传出电子邮件的主题
正文（文本格式）
 bodytext string

传出电子邮件的纯文本版本。
正文（采用 HTML 格式）
 bodyhtml string

传出电子邮件的 HTML 版本。
SMTP 服务器
 smtpserver True string

SMTP 服务器地址
SMTP 端口
 smtpport True string

SMTP 端口
SMTP 用户名
 smtpusername True string

SMTP 服务器用户名
SMTP 密码
 smtppassword True string

SMTP 服务器密码，如果使用 Gmail，则需要按照以下说明 https://support.google.com/accounts/answer/185833生成特定于应用的密码。
Profiles
 profiles string

使用此参数可设置用于微调和额外选项的其他配置。 浏览 PDF.co 知识库（https://developer.pdf.co/api/profiles/index.html）了解配置文件示例。
异步
 async boolean

对于在后台运行的长进程，API 将返回一个 jobId，可用于 JobCheck 终结点检查进程的状态并检索输出，同时你可以继续执行其他任务，而无需等待此过程完成。

返回

名称 路径 类型 说明
作业 ID
 jobId string

jobId
错误
 error boolean

错误
状态
 status integer

状态
贷项
 credits integer

积分
剩余额度
 remainingCredits integer

remainingCredits
持续时间
 duration integer

duration

合并 PDF

操作 ID:
MergePdfSimplified

将两个或多个 PDF 文件中的 PDF 合并为新的 PDF 文件。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/pdf-merge/index.html 。

参数

名称 密钥 必需 类型 说明
URL
 url True string

指向 PDF 文件的链接的逗号分隔列表。 支持从 PDF.co 文件存储到外部站点 filetoken://.. 的链接，以及指向 G 驱动器、Dropbox 和其他服务的链接。 无需密码即可访问链接。 对于受密码保护的 PDF 文件，请先使用 PDF 安全模块解锁输入 pdf。
过期日期
 expiration integer

设置输出链接的过期时间（默认值为 60 分钟或 1 小时），在此指定的持续时间后，将从 PDF.co 临时文件存储中删除任何生成的输出文件（s）。 链接过期的最大持续时间因当前订阅计划而异。
Profiles
 profiles string

使用此参数可设置用于微调和额外选项的其他配置。 浏览 PDF.co 知识库（https://developer.pdf.co/api/profiles/index.html）了解配置文件示例。
异步
 async boolean

对于在后台运行的长进程，API 将返回一个 jobId，可用于 JobCheck 终结点检查进程的状态并检索输出，同时你可以继续执行其他任务，而无需等待此过程完成。

返回

名称 路径 类型 说明
URL
 url string

输出文档 URL。
作业 ID
 jobId string

jobId
页计数
 pageCount integer

输出文档中的页数。
错误
 error boolean

指示作是否成功。
状态代码
 status integer

HTTP 响应的状态代码
Name
 name string

输出文档名称
贷项
 credits integer

用于此请求的 PDF.co 信用额度
持续时间
 duration integer

请求执行持续时间
剩余额度
 remainingCredits integer

PDF.co 帐户剩余额度

合并 PDF （高级）

操作 ID:
MergePdf

将两个或多个 pdf、doc、xls、图像中的 PDF 合并到新的 PDF 中，甚至将文档和图像压缩为新的 PDF。 支持 zip、doc、docx、xls、xlsx、rtf、txt、png、jpg。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/pdf-merge/index.html#post-tag-pdf-merge2 。

参数

名称 密钥 必需 类型 说明
URL
 url True string

指向 PDF、文档、电子表格、图像的链接的逗号分隔列表。 支持从 PDF.co 文件存储到外部站点 filetoken://.. 的链接，以及指向 G 驱动器、Dropbox 和其他服务的链接。 无需密码即可访问链接。 对于受密码保护的 PDF 文件，请先使用 PDF 安全模块解锁输入 pdf。
过期日期
 expiration integer

设置输出链接的过期时间（默认值为 60 分钟或 1 小时），在此指定的持续时间后，将从 PDF.co 临时文件存储中删除任何生成的输出文件（s）。 链接过期的最大持续时间因当前订阅计划而异。
Profiles
 profiles string

使用此参数可设置用于微调和额外选项的其他配置。 浏览 PDF.co 知识库（https://developer.pdf.co/api/profiles/index.html）了解配置文件示例。
异步
 async boolean

对于在后台运行的长进程，API 将返回一个 jobId，可用于 JobCheck 终结点检查进程的状态并检索输出，同时你可以继续执行其他任务，而无需等待此过程完成。

返回

名称 路径 类型 说明
URL
 url string

输出文档 URL。
作业 ID
 jobId string

jobId
页计数
 pageCount integer

输出文档中的页数。
错误
 error boolean

指示作是否成功。
状态代码
 status integer

HTTP 响应的状态代码
Name
 name string

输出文档名称
贷项
 credits integer

用于此请求的 PDF.co 信用额度
持续时间
 duration integer

请求执行持续时间
剩余额度
 remainingCredits integer

PDF.co 帐户剩余额度

后台作业检查

操作 ID:
JobCheck

检查以前使用 PDF.co API 创建的后台作业的状态。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/background-job-check/index.html 。

参数

名称 密钥 必需 类型 说明
作业 ID
 jobid True string

PDF.co 后台作业 ID

返回

名称 路径 类型 说明
状态
 status string

状态
网址
 url string

网址
作业 ID
 jobId string

jobId
持续时间
 duration integer

duration

将扫描的 PDF 设置为文本可搜索

操作 ID:
PDFSearchable

将 PDF 和扫描的 JPG、PNG 图像转换为文本可搜索的 PDF。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/pdf-make-text-searchable-or-unsearchable/index.html#post-tag-pdf-makesearchable 。

参数

名称 密钥 必需 类型 说明
URL
 url True string

源文件的 URL。 支持 Google Drive、Dropbox 和 PDF.co 内置文件存储的链接。
OCR 语言
 lang string

提取文本时用于扫描的 PDF、PNG 和 JPG 文档输入的 OCR（图像中的文本）的语言。 默认值为“eng”。 还支持其他语言：deu、spa、chi_sim、jpn 和许多其他语言（支持的 OCR 语言的完整列表位于 ）。https://developer.pdf.co/api/pdf-make-text-searchable-or-unsearchable/index.html#language-support 还可以同时使用 2 种语言，如下所示：eng+deu 或 jpn+kor（任意组合）。
页
 pages string

要处理的页索引（或范围）的逗号分隔列表。 第一页从 0 开始（零）。 若要设置范围，请使用短划线 -，例如：0,2-5,7-。 若要将索引范围设置为最后一页，请使用如下所示的范围：2- （从第 3 页开始，索引从零开始，直到文档开始）。 对于 ALL 页面，只需将此参数留空。 示例：0,2-5,7 - 表示第一页，第 3 页到第 6 页，然后从第 8 页（索引 = 7）页到文档末尾的范围。
密码
 password string

PDF 文件的密码
异步
 async boolean

对于在后台运行的长进程，将 Async 设置为 true，API 将返回一个 jobId，与 JobCheck 模块一起使用以检查进程的状态并检索输出，而你可以继续执行其他任务，而无需等待此过程完成。
Profiles
 profiles string

使用此参数可设置用于微调和额外选项的其他配置。 浏览 PDF.co 知识库（https://developer.pdf.co/api/profiles/index.html）了解配置文件示例。

返回

名称 路径 类型 说明
URL
 url string

网址
作业 ID
 jobId string

jobId
页计数
 pageCount integer

pageCount
错误
 error boolean

错误
状态
 status integer

状态
贷项
 credits integer

积分
剩余额度
 remainingCredits integer

remainingCredits
持续时间
 duration integer

duration

将文本、图像、窗体字段添加到 PDF

操作 ID:
PdfFiller

向 pdf 添加文本、图像、签名。 填写 PDF 表单字段，并从模板创建新的 PDF。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/pdf-add/index.html 。

参数

名称 密钥 必需 类型 说明
URL
 url True string

输入 PDF 文档的 URL
批注字符串
 annotationsString string

要添加到 PDF 文档中的批注字符串。 格式应类似于“x;y;页;text“. 有关更高级的格式和示例，请参阅 PDF.co 文档。
图像字符串
 imagesString string

要添加到 PDF 文档的图像。 格式应类似于“x;y;页;urltoimage;链接;宽度;height“. 有关更高级的格式和示例，请参阅 PDF.co 文档。
字段字符串
 fieldsString string

填写 PDF 表单字段。 格式应类似于“page;fieldName;value“. 有关更高级的格式和示例，请参阅 PDF.co 文档。
Name
 name string

输出 PDF 名称
内联
 inline boolean

确定是否在响应中返回输出或链接到输出文件。
过期日期
 expiration integer

设置输出链接的过期时间（默认值为 60 分钟或 1 小时），在此指定的持续时间后，将从 PDF.co 临时文件存储中删除任何生成的输出文件（s）。 链接过期的最大持续时间因当前订阅计划而异。
Profiles
 profiles string

此参数可用于设置用于微调的其他配置，并启用更多选项。 请访问 PDF.co 知识库（https://developer.pdf.co/api/profiles/index.html）了解配置文件示例等。
异步
 async boolean

对于在后台运行的长进程，API 将返回一个 jobId，与 JobCheck 终结点一起使用以检查进程状态并检索输出，而你可以继续执行其他任务，而无需等待此过程完成。

返回

名称 路径 类型 说明
URL
 url string

输出文档 URL。
作业 ID
 jobId string

jobId
页计数
 pageCount integer

输出文档中的页数。
错误
 error boolean

指示作是否成功。
状态代码
 status integer

HTTP 响应的状态代码
Name
 name string

输出文档名称
贷项
 credits integer

用于此请求的 PDF.co 信用额度
持续时间
 duration integer

请求执行持续时间
剩余额度
 remainingCredits integer

PDF.co 帐户剩余额度

拆分 PDF

操作 ID:
SplitPdf

使用页码和页范围将 PDF 文档中的页面拆分为多个新的 PDF 文件。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/pdf-split/index.html 。

参数

名称 密钥 必需 类型 说明
URL
 url True string

源 PDF 文档的 URL
页
 pages True string

要拆分为的页面索引（或范围）的逗号分隔列表。 第一页为 1（一页）。 示例：“1,2-5,7-”。 特殊情况：将每页提取到单独的 PDF 中。*
内联
 inline boolean

确定是否在响应中返回输出或链接到输出文件。
Name
 name string

新 PDF 文件的基文件名
过期日期
 expiration integer

设置输出链接的过期时间（默认值为 60 分钟或 1 小时），在此指定的持续时间后，将从 PDF.co 临时文件存储中删除任何生成的输出文件（s）。 链接过期的最大持续时间因当前订阅计划而异。
Profiles
 profiles string

使用此参数可设置用于微调和额外选项的其他配置。 浏览 PDF.co 知识库（https://developer.pdf.co/api/profiles/index.html）了解配置文件示例。
异步
 async boolean

创建后台处理作业。

返回

名称 路径 类型 说明
网址
 urls array of string

网址
URL
 url string

输出文档 URL。
作业 ID
 jobId string

jobId
页计数
 pageCount integer

输出文档中的页数。
错误
 error boolean

指示作是否成功。
状态
 status integer

HTTP 响应的状态代码
Name
 name string

输出文档名称
贷项
 credits integer

用于此请求的 PDF.co 信用额度
持续时间
 duration integer

请求执行持续时间
剩余额度
 remainingCredits integer

PDF.co 帐户剩余额度

拆分 PDF （高级）

操作 ID:
SplitPdf2

通过文本搜索（支持正则表达式）或条形码将 PDF 拆分为多个 PDF 文件。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/pdf-split/index.html#post-tag-pdf-split2 。

参数

名称 密钥 必需 类型 说明
URL
 url True string

源 PDF 文档的 URL
搜索字符串
 searchString True string

在页面上搜索的文本。 还可以按条形码搜索，了解详细信息访问 https://developer.pdf.co/api/pdf-split/index.html?utm_source=api-docs#post-tag-pdf-split2
排除键页
 excludeKeyPages boolean

如果要排除找到文本的页面，则设置为 true
regexSearch
 regexSearch boolean

设置为 true 以启用搜索字符串的正则表达式
区分大小写
 caseSensitive boolean

设置为 true 以启用区分大小写的搜索。
OCR 语言
 lang string

提取文本时用于扫描的 PDF、PNG 和 JPG 文档输入的 OCR（图像中的文本）的语言。 默认值为“eng”。 还支持其他语言：deu、spa、chi_sim、jpn 和许多其他语言（支持的 OCR 语言的完整列表位于 ）。https://developer.pdf.co/api/pdf-make-text-searchable-or-unsearchable/index.html#language-support 还可以同时使用 2 种语言，如下所示：eng+deu 或 jpn+kor（任意组合）。
内联
 inline boolean

确定是否在响应中返回输出或链接到输出文件。
Name
 name string

新 PDF 文件的基文件名
过期日期
 expiration integer

设置输出链接的过期时间（默认值为 60 分钟或 1 小时），在此指定的持续时间后，将从 PDF.co 临时文件存储中删除任何生成的输出文件（s）。 链接过期的最大持续时间因当前订阅计划而异。
Profiles
 profiles string

使用此参数可设置用于微调和额外选项的其他配置。 浏览 PDF.co 知识库（https://developer.pdf.co/api/profiles/index.html）了解配置文件示例。
异步
 async boolean

创建后台处理作业。

返回

名称 路径 类型 说明
网址
 urls array of string

网址
URL
 url string

输出文档 URL。
作业 ID
 jobId string

jobId
页计数
 pageCount integer

输出文档中的页数。
错误
 error boolean

指示作是否成功。
状态
 status integer

HTTP 响应的状态代码
Name
 name string

输出文档名称
贷项
 credits integer

用于此请求的 PDF.co 信用额度
持续时间
 duration integer

请求执行持续时间
剩余额度
 remainingCredits integer

PDF.co 帐户剩余额度

指向 PDF 的 URL

操作 ID:
UrlToPdf

从 URL 创建 PDF。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/pdf-from-url/index.html 。

参数

名称 密钥 必需 类型 说明
URL
 url True string

要转换的输入 HTML 文件或网站页面的链接。 可以通过 Google Drive、Dropbox 或其他可生成可共享链接的在线文件服务将链接传递给文件。
边距
 margins string

输出文档中要使用的边距。 设置为 css 样式边距，如 10px、5mm、5 英寸（所有侧面为 5px 5px 5px 5px（边距顺序为顶部、右、下、左）。
纸张大小
 paperSize string

默认设置字母。 可以是字母、法律、小报、账本、A0、A1、A2、A3、A4、A5、A6 或自定义大小。 自定义大小可以设置为 px（像素）、mm 或（英寸），宽度和高度用空格分隔，如下所示：200 300、200px 300px、200mm 300mm、20cm 30 厘米或 6 英寸 8 英寸。
方向
 orientation string

输出页面方向
打印背景
 printBackground boolean

启用或禁用文档背景打印
Header
 header html

设置为 HTML，以便在页眉的每个页面上应用标头。
页脚
 footer html

设置为 HTML，以便在底部的每一页上应用页脚。
过期日期
 expiration integer

设置输出链接的过期时间（默认值为 60 分钟或 1 小时），在此指定的持续时间后，将从 PDF.co 临时文件存储中删除任何生成的输出文件（s）。 链接过期的最大持续时间因当前订阅计划而异。
Profiles
 profiles string

此参数可用于设置用于微调的其他配置，并启用更多选项。 请访问 PDF.co 知识库（https://developer.pdf.co/api/profiles/index.html）了解配置文件示例等。
异步
 async boolean

对于在后台运行的长进程，API 将返回一个 jobId，与 JobCheck 终结点一起使用以检查进程状态并检索输出，而你可以继续执行其他任务，而无需等待此过程完成。

返回

名称 路径 类型 说明
URL
 url string

输出文档 URL。
作业 ID
 jobId string

jobId
页计数
 pageCount integer

输出文档中的页数。
错误
 error boolean

指示作是否成功。
状态代码
 status integer

HTTP 响应的状态代码
Name
 name string

输出文档名称
贷项
 credits integer

用于此请求的 PDF.co 信用额度
持续时间
 duration integer

请求执行持续时间
剩余额度
 remainingCredits integer

PDF.co 帐户剩余额度

文档分析器

操作 ID:
DocumentParser

文档分析器可以自动分析 PDF、JPG 和 PNG 文档，以从发票、语句、订单和其他 PDF 和扫描的文档中提取字段、表、值和条形码。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/document-parser/index.html 。

参数

名称 密钥 必需 类型 说明
URL
 url True string

源文件的 URL。 支持 Google Drive、Dropbox 和 PDF.co 内置文件存储的链接。 若要通过 API 上传文件，请查看“文件上传”部分 https://developer.pdf.co/api/file-upload/index.html
模板 ID
 templateId string

设置要使用的文档分析器模板的 ID。 查看和管理模板 https://app.pdf.co/document-parser
输出格式
 outputFormat True string

默认值为 JSON。 可以将默认输出格式重写为 CSV 或 XML，以便相应地生成 CSV 或 XML 输出。
内联
 inline boolean

设置为 true 以在响应中返回结果。 否则，终结点将返回指向生成的输出文件的链接
密码
 password string

PDF 文件的密码
Profiles
 profiles string

使用此参数可设置用于微调和额外选项的其他配置。 浏览配置文件示例 PDF.co 知识库 https://developer.pdf.co/api/profiles/index.html ，
过期日期
 expiration integer

设置输出链接的过期时间（默认值为 60 分钟或 1 小时），在此指定的持续时间后，将从 PDF.co 临时文件存储中删除任何生成的输出文件（s）。 链接过期的最大持续时间因当前订阅计划而异。
异步
 async boolean

对于在后台运行的长进程，API 将返回一个 jobId，该作业 Id 可与“作业检查”一起使用，检查进程的状态并检索输出，同时你可以继续执行其他任务，而无需等待此过程完成。

返回

名称 路径 类型 说明
URL
 url string

输出 URL
对象
 body.objects array of object

tables
姓名
 body.objects.name string

姓名
objectType
 body.objects.objectType string

对象的类型
value
 body.objects.value string

value
pageIndex
 body.objects.pageIndex integer

pageIndex
矩形
 body.objects.rectangle array of float

矩形
行
 body.objects.rows array of object

行
items
 body.objects.rows object
页计数
 pageCount integer
作业 ID
 jobId string
状态
 status integer
Name
 name string
剩余额度
 remainingCredits integer
Message
 message string

文档分类器

操作 ID:
PDFClassifier

基于基于关键字的规则自动分类传入文档。 例如，可以定义规则来查找哪个供应商提供了相应文档来查找相应应用的模板。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/document-classifier/index.html 。

参数

名称 密钥 必需 类型 说明
URL
 url True string

源文件的 URL。 支持 Google Drive、Dropbox 和 PDF.co 内置文件存储的链接。
规则（CSV 格式）
 rulescsv string

以 CSV 格式定义自定义分类规则。 规则采用 CSV 格式，其中每一行都包含：“类名、逻辑（AND 或 OR（默认值）”和关键字“，用逗号分隔。 每一行由 \n 符号分隔。
规则 URL （CSV 格式）
 rulescsvurl string

可以使用此参数而不是内联 CSV，并使用分类规则将 URL 设置为 CSV 文件。 如果你有单独的开发人员处理 CSV 规则，这非常有用。
区分大小写
 caseSensitive boolean

定义规则中的关键字是否区分大小写。
内联
 inline boolean

设置为 true 以在响应中返回结果。 否则，终结点将返回指向生成的输出文件的链接。
过期日期
 expiration integer

设置输出链接的过期时间（默认值为 60 分钟或 1 小时），在此指定的持续时间后，将从 PDF.co 临时文件存储中删除任何生成的输出文件（s）。 链接过期的最大持续时间因当前订阅计划而异。
密码
 password string

PDF 文件的密码
Profiles
 profiles string

使用此参数可设置用于微调和额外选项的其他配置。 浏览 PDF.co 知识库（https://developer.pdf.co/api/profiles/index.html）了解配置文件示例。
异步
 async boolean

对于在后台运行的长进程，API 将返回一个 jobId，可用于 JobCheck 终结点检查进程的状态并检索输出，同时你可以继续执行其他任务，而无需等待此过程完成。

返回

名称 路径 类型 说明
URL
 url string

网址
classes
 body.classes array of object
Class
 body.classes.class string
作业 ID
 jobId string

jobId
页计数
 pageCount integer

pageCount
错误
 error boolean

错误
状态
 status integer

状态
Name
 name string

姓名
贷项
 credits integer

积分
剩余额度
 remainingCredits integer

remainingCredits
持续时间
 duration integer

duration

文档的 PDF（Doc、DocX、RTF、TXT、XPS）

操作 ID:
PDFFromDoc

将 DOC、DOCX、RTF、TXT、XPS 文件转换为 PDF。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/pdf-from-document/index.html#post-tag-pdf-convert-from-doc 。

参数

名称 密钥 必需 类型 说明
URL
 url True string

源文件的 URL。 支持 Google Drive、Dropbox 和 PDF.co 内置文件存储的链接。
页
 pages string

要处理的页索引（或范围）的逗号分隔列表。 第一页从 0 开始（零）。 若要设置范围，请使用短划线 -，例如：0,2-5,7-。 若要将索引范围设置为最后一页，请使用如下所示的范围：2- （从第 3 页开始，索引从零开始，直到文档开始）。 对于 ALL 页面，只需将此参数留空。 示例：0,2-5,7 - 表示第一页，第 3 页到第 6 页，然后从第 8 页（索引 = 7）页到文档末尾的范围。
Name
 name string

生成的输出的文件名。
过期日期
 expiration integer

设置输出链接的过期时间（默认值为 60 分钟或 1 小时），在此指定的持续时间后，将从 PDF.co 临时文件存储中删除任何生成的输出文件（s）。 链接过期的最大持续时间因当前订阅计划而异。
异步
 async boolean

对于在后台运行的长进程，API 将返回一个 jobId，与 JobCheck 终结点一起使用以检查进程状态并检索输出，而你可以继续执行其他任务，而无需等待此过程完成。
Profiles
 profiles string

可以使用此参数设置其他和额外的选项，以便设置自定义配置。 浏览 PDF.co 知识库（https://developer.pdf.co/api/profiles/index.html）了解配置文件示例。

返回

名称 路径 类型 说明
URL
 url string
作业 ID
 jobId string

jobId
页计数
 pageCount integer

pageCount
错误
 error boolean

错误
状态
 status integer

状态
Name
 name string

姓名
贷项
 credits integer

积分
剩余额度
 remainingCredits integer

remainingCredits
持续时间
 duration integer

duration

旋转 PDF 页面

操作 ID:
PDFRotatePages

旋转 PDF 页面。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/pdf-rotate-pages/index.html 。

参数

名称 密钥 必需 类型 说明
URL
 url True string

源文件的 URL。 支持 Google Drive、Dropbox 和 PDF.co 内置文件存储的链接。
角度
 angle integer

角度（以度为单位）。 支持的值 90、180 和 270。
页
 pages string

要处理的页索引（或范围）的逗号分隔列表。 第一页从 0 开始（零）。 若要设置范围，请使用短划线 -，例如：0,2-5,7-。 若要将索引范围设置为最后一页，请使用如下所示的范围：2- （从第 3 页开始，索引从零开始，直到文档开始）。 对于 ALL 页面，只需将此参数留空。 示例：0,2-5,7 - 表示第一页，第 3 页到第 6 页，然后从第 8 页（索引 = 7）页到文档末尾的范围。
过期日期
 expiration integer

设置输出链接的过期时间（默认值为 60 分钟或 1 小时），在此指定的持续时间后，将从 PDF.co 临时文件存储中删除任何生成的输出文件（s）。 链接过期的最大持续时间因当前订阅计划而异。
密码
 password string

PDF 文件的密码
Profiles
 profiles string

使用此参数可设置用于微调和额外选项的其他配置。 浏览 PDF.co 知识库（https://developer.pdf.co/api/profiles/index.html）了解配置文件示例。
异步
 async boolean

对于在后台运行的长进程，API 将返回一个 jobId，可用于 JobCheck 终结点检查进程的状态并检索输出，同时你可以继续执行其他任务，而无需等待此过程完成。

返回

名称 路径 类型 说明
URL
 url string

网址
作业 ID
 jobId string

jobId
页计数
 pageCount integer

pageCount
错误
 error boolean

错误
状态
 status integer

状态
Name
 name string

姓名
贷项
 credits integer

积分
剩余额度
 remainingCredits integer

remainingCredits
持续时间
 duration integer

duration

旋转 PDF 页面 （自动）

操作 ID:
PDFAutoRotatePages

使用 AI 根据文本分析自动修复扫描 PDF 中页面的旋转。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/pdf-rotate-pages/index.html#post-tag-pdf-edit-rotate-auto 。

参数

名称 密钥 必需 类型 说明
URL
 url True string

源文件的 URL。 支持 Google Drive、Dropbox 和 PDF.co 内置文件存储的链接。
OCR 语言
 lang string

提取文本时用于扫描的 PDF、PNG 和 JPG 文档输入的 OCR（图像中的文本）的语言。 默认值为“eng”。 还支持其他语言：deu、spa、chi_sim、jpn 和许多其他语言（支持的 OCR 语言的完整列表位于 ）。https://developer.pdf.co/api/pdf-make-text-searchable-or-unsearchable/index.html#language-support 还可以同时使用 2 种语言，如下所示：eng+deu 或 jpn+kor（任意组合）。
过期日期
 expiration integer

设置输出链接的过期时间（默认值为 60 分钟或 1 小时），在此指定的持续时间后，将从 PDF.co 临时文件存储中删除任何生成的输出文件（s）。 链接过期的最大持续时间因当前订阅计划而异。
密码
 password string

PDF 文件的密码
Profiles
 profiles string

使用此参数可设置用于微调和额外选项的其他配置。 浏览 PDF.co 知识库（https://developer.pdf.co/api/profiles/index.html）了解配置文件示例。
异步
 async boolean

对于在后台运行的长进程，API 将返回一个 jobId，可用于 JobCheck 终结点检查进程的状态并检索输出，同时你可以继续执行其他任务，而无需等待此过程完成。

返回

名称 路径 类型 说明
URL
 url string

网址
作业 ID
 jobId string

jobId
页计数
 pageCount integer

pageCount
错误
 error boolean

错误
状态
 status integer

状态
Name
 name string

姓名
贷项
 credits integer

积分
剩余额度
 remainingCredits integer

remainingCredits
持续时间
 duration integer

duration

条形码生成器

操作 ID:
BarcodeGenerator

生成高质量的条形码图像。 支持 QR 码、Datamatrix、Code 39、Code 128、PDF417 和其他许多条形码类型。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/barcode-generator/index.html 。

参数

名称 密钥 必需 类型 说明
Name
 name string

对于在后台运行的长进程，API 将返回一个 jobId，与 /job/check 终结点一起使用以检查进程的状态并检索输出，同时你可以继续执行其他任务，而无需等待此过程完成。
价值
 value True string

设置字符串值以在条形码中进行编码。
类型
 type True string

设置条形码类型，默认为 QRCode。
修饰图像
 decorationImage string

将此设置为要在 QR-Code 条形码中插入徽标的图像。
异步
 async boolean

对于在后台运行的长进程，API 将返回一个 jobId，与 JobCheck 模块一起使用以检查进程状态并检索输出，同时你可以继续执行其他任务，而无需等待此过程完成。
过期日期
 expiration integer

设置输出链接的过期时间（默认值为 60 分钟或 1 小时），在此指定的持续时间后，将从 PDF.co 临时文件存储中删除任何生成的输出文件（s）。 链接过期的最大持续时间因当前订阅计划而异。
Profiles
 profiles string

使用此参数可设置用于微调和额外选项的其他配置。 浏览 PDF.co 知识库 https://developer.pdf.co/api/profiles/index.html 了解配置文件示例

返回

名称 路径 类型 说明
JobId
 jobId string

jobId
URL
 url string

网址
错误
 error boolean

错误
状态
 status integer

状态
Name
 name string

姓名
贷项
 credits integer

积分
剩余额度
 remainingCredits integer

remainingCredits
持续时间
 duration integer

duration

条形码阅读器

操作 ID:
BarcodeReader

从图像和 PDF 读取条形码。 可以从 QR 码和代码 128、EAN 到 Datamatrix、PDF417、GS1 和许多其他条形码读取所有常用条形码类型。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/barcode-reader/index.html 。

参数

名称 密钥 必需 类型 说明
URL
 url True string

源文件的 URL。 支持 Google Drive、Dropbox 和 PDF.co 内置文件存储的链接。
类型
 types True string

设置条形码类型，QRCode 为默认值。 还可以按逗号合并类型，例如“QRCode，Code128，Code39，Interleaved2of5，EAN13”。 所有支持的条形码类型均为 AustralianPostCode、Aztec、BorderedTable、Checkbox、Circle、CircularI2of5、Codabar、CodablockF、Code128、Code16K、Code39、Code39Extended、Code39Mod43、Code39Mod43Extended、Code93、DataMatrix、DPMDataMatrix、EAN13、EAN2、EAN5、 EAN8、GS1、GS1DataBarExpanded、GS1DataBarExpandedStacked、GS1DataBarLimited、GS1DataBarOmnidirectional、GS1DataBarStacked、GTIN12、GTIN13、GTIN14、GTIN8、HorizontalLine、IntelligentMail、Interleaved2of5、ITF14、MaxiCode、MICR、MicroPDF、MSI、Oval、PatchCode、PDF417、Pharmacode、PostNet、PZN、QRCode、Rectangle、RoyalMail、RoyalMail、RoyalMailKIX、Segment、Trioptic、UnderlinedField、UPCA、UPCE、UPU、VerticalLine。
页
 pages string

Comma-Separated 要处理的页索引列表（或范围）。 重要说明：第一页从 0 开始（零）。 若要设置范围，请使用短划线 -，例如：0,2-5,7-。 若要将索引范围设置为最后一页，请使用如下所示的范围：2- （从第 3 页开始，索引从零开始，直到文档末尾）。 对于 ALL 页面，只需将此参数留空。 示例：0,2-5,7 - 表示第一页，第三页到第六页，然后从第 8 页（索引 = 7）页到文档末尾的范围。
Profiles
 profiles string

使用此参数可设置用于微调和额外选项的其他配置。 浏览 PDF.co 知识库（https://developer.pdf.co/api/profiles/index.html）了解配置文件示例。
异步
 async boolean

对于在后台运行的长进程，API 将返回一个 jobId，与 JobCheck 模块一起使用以检查进程状态并检索输出，而你可以继续执行其他任务，而无需等待此过程完成。

返回

名称 路径 类型 说明
JobId
 jobId string

jobId
URL
 url string

网址
条形码
 barcodes array of object

条形码
价值
 barcodes.Value string

价值
类型
 barcodes.Type integer

类型
矩形
 barcodes.Rect string

矩形
页
 barcodes.Page integer

页
文件
 barcodes.File string

文件
置信度
 barcodes.Confidence float

置信度
Metadata
 barcodes.Metadata string

Metadata
类型名称
 barcodes.TypeName string

类型名称
页计数
 pageCount integer

pageCount
错误
 error boolean

错误
状态
 status integer

状态
贷项
 credits integer

积分
剩余额度
 remainingCredits integer

remainingCredits
持续时间
 duration integer

duration

来自 CSV 的 PDF

操作 ID:
PDFFromCSV

将 CSV 文档转换为 PDF。 也适用于 XLS 或 XLSX 输入。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/pdf-from-document/index.html#post-tag-pdf-convert-from-csv 。

参数

名称 密钥 必需 类型 说明
URL
 url True string

源文件的 URL。 支持 Google Drive、Dropbox 和 PDF.co 内置文件存储的链接。
页
 pages string

要处理的页索引（或范围）的逗号分隔列表。 第一页从 0 开始（零）。 若要设置范围，请使用短划线 -，例如：0,2-5,7-。 若要将索引范围设置为最后一页，请使用如下所示的范围：2- （从第 3 页开始，索引从零开始，直到文档开始）。 对于 ALL 页面，只需将此参数留空。 示例：0,2-5,7 - 表示第一页，第 3 页到第 6 页，然后从第 8 页（索引 = 7）页到文档末尾的范围。
Name
 name string

生成的输出的文件名。
过期日期
 expiration integer

设置输出链接的过期时间（默认值为 60 分钟或 1 小时），在此指定的持续时间后，将从 PDF.co 临时文件存储中删除任何生成的输出文件（s）。 链接过期的最大持续时间因当前订阅计划而异。
异步
 async boolean

对于在后台运行的长进程，API 将返回一个 jobId，与 JobCheck 终结点一起使用以检查进程状态并检索输出，而你可以继续执行其他任务，而无需等待此过程完成。
Profiles
 profiles string

可以使用此参数设置其他和额外的选项，以便设置自定义配置。 浏览 PDF.co 知识库（https://developer.pdf.co/api/profiles/index.html）了解配置文件示例。

返回

名称 路径 类型 说明
URL
 url string
作业 ID
 jobId string

jobId
页计数
 pageCount integer

pageCount
错误
 error boolean

错误
状态
 status integer

状态
Name
 name string

姓名
贷项
 credits integer

积分
剩余额度
 remainingCredits integer

remainingCredits
持续时间
 duration integer

duration

来自图像的 PDF

操作 ID:
PDFFromImages

从一个或多个 JPG、PNG、TIFF 图像创建 PDF 文件。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/pdf-from-image/index.html 。

参数

名称 密钥 必需 类型 说明
网址
 url True string

源文件的 URL。 以逗号分隔格式提供多个 URL。 支持 Google Drive、Dropbox 和 PDF.co 内置文件存储的链接。
Name
 name string

生成的输出的文件名。
过期日期
 expiration integer

设置输出链接的过期时间（默认值为 60 分钟或 1 小时），在此指定的持续时间后，将从 PDF.co 临时文件存储中删除任何生成的输出文件（s）。 链接过期的最大持续时间因当前订阅计划而异。
异步
 async boolean

对于在后台运行的长进程，API 将返回一个 jobId，与 JobCheck 终结点一起使用以检查进程状态并检索输出，而你可以继续执行其他任务，而无需等待此过程完成。
Profiles
 profiles string

可以使用此参数设置其他和额外的选项，以便设置自定义配置。 浏览 PDF.co 知识库（https://developer.pdf.co/api/profiles/index.html）了解配置文件示例。

返回

名称 路径 类型 说明
URL
 url string
作业 ID
 jobId string

jobId
页计数
 pageCount integer

pageCount
错误
 error boolean

错误
状态
 status integer

状态
Name
 name string

姓名
贷项
 credits integer

积分
剩余额度
 remainingCredits integer

remainingCredits
持续时间
 duration integer

duration

来自电子表格的 PDF

操作 ID:
PDFFromXLSXLSX

从 XLS、XLSX 电子表格创建 PDF。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/convert-excel/index.html#post-tag-xls-convert-to-pdf 。

参数

名称 密钥 必需 类型 说明
URL
 url True string

源文件的 URL。 支持 Google Drive、Dropbox 和 PDF.co 内置文件存储的链接。
工作表索引
 worksheetIndex string

设置 WorkSheet 索引（默认值为 0）。
Name
 name string

生成的输出的文件名。
过期日期
 expiration integer

设置输出链接的过期时间（默认值为 60 分钟或 1 小时），在此指定的持续时间后，将从 PDF.co 临时文件存储中删除任何生成的输出文件（s）。 链接过期的最大持续时间因当前订阅计划而异。
异步
 async boolean

对于在后台运行的长进程，API 将返回一个 jobId，与 JobCheck 终结点一起使用以检查进程状态并检索输出，而你可以继续执行其他任务，而无需等待此过程完成。
Profiles
 profiles string

可以使用此参数设置其他和额外的选项，以便设置自定义配置。 浏览 PDF.co 知识库（https://developer.pdf.co/api/profiles/index.html）了解配置文件示例。

返回

名称 路径 类型 说明
URL
 url string
作业 ID
 jobId string

jobId
页计数
 pageCount integer

pageCount
错误
 error boolean

错误
状态
 status integer

状态
Name
 name string

姓名
贷项
 credits integer

积分
剩余额度
 remainingCredits integer

remainingCredits
持续时间
 duration integer

duration

来自电子邮件的 PDF

操作 ID:
PDFFromEmail

将电子邮件文件（MSG 或 EML）代码转换为 PDF。 从输入电子邮件中提取附件（如果有），并将其作为 pdf 附件嵌入 PDF。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/pdf-from-email/index.html 。

参数

名称 密钥 必需 类型 说明
URL
 url True string

源文件的 URL。 支持 Google Drive、Dropbox 和 PDF.co 内置文件存储的链接。
嵌入附件
 embedAttachments boolean

设置为 true 可自动将所有附件从原始输入电子邮件 MSG 或 EML 文件嵌入到最终输出 PDF 中。 如果不想嵌入附件，则将其设置为 false，以便仅转换输入电子邮件的正文。
转换附件
 convertAttachments boolean

如果不想从原始电子邮件转换附件，并且希望将其嵌入为原始文件（作为嵌入的 pdf 附件），则设置为 false。 将 API 支持的附件（DOC、DOCx、HTML、PNG、JPG 等）转换为 PDF，并合并到输出最终 PDF。 不支持的文件类型将添加为 PDF 附件（可能需要 Adobe Reader 或其他查看器才能查看 PDF 附件）。
边距
 margins string

设置为 CSS 样式边距，如 10px、5mm、5 英寸（所有方面为 5px 5px 5px 5px（边距顺序为顶部、右、下、左）。
纸张大小
 paperSize string

默认设置字母。 可以是字母、法律、小报、账本、A0、A1、A2、A3、A4、A5、A6 或自定义大小。 自定义大小可以设置为 px（像素）、mm 或（英寸），宽度和高度用空格分隔，如下所示：200 300、200px 300px、200mm 300mm、20cm 30 厘米或 6 英寸 8 英寸。
方向
 orientation string
Name
 name string

生成的输出的文件名。
过期日期
 expiration integer

设置输出链接的过期时间（默认值为 60 分钟或 1 小时），在此指定的持续时间后，将从 PDF.co 临时文件存储中删除任何生成的输出文件（s）。 链接过期的最大持续时间因当前订阅计划而异。
异步
 async boolean

对于在后台运行的长进程，API 将返回一个 jobId，与 JobCheck 终结点一起使用以检查进程状态并检索输出，而你可以继续执行其他任务，而无需等待此过程完成。
Profiles
 profiles string

可以使用此参数设置其他和额外的选项，以便设置自定义配置。 浏览 PDF.co 知识库（https://developer.pdf.co/api/profiles/index.html）了解配置文件示例。

返回

名称 路径 类型 说明
URL
 url string
作业 ID
 jobId string

jobId
页计数
 pageCount integer

pageCount
错误
 error boolean

错误
状态
 status integer

状态
Name
 name string

姓名
贷项
 credits integer

积分
剩余额度
 remainingCredits integer

remainingCredits
持续时间
 duration integer

duration

电子表格到 CSV

操作 ID:
XLStoCSV

将 XLS/XLSX 转换为 CSV 逗号分隔值文件。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/convert-excel/index.html#post-tag-xls-convert-to-csv 。

参数

名称 密钥 必需 类型 说明
URL
 url True string

源文件的 URL。 支持 Google Drive、Dropbox 和 PDF.co 内置文件存储的链接。
工作表索引
 worksheetIndex string

设置 WorkSheet 索引（默认值为 0）。
引号符号
 quotationSymbol string

设置 CSV 引号
分隔符符号
 separatorSymbol string

设置 CSV 分隔符
Name
 name string

生成的输出的文件名。
过期日期
 expiration integer

设置输出链接的过期时间（默认值为 60 分钟或 1 小时），在此指定的持续时间后，将从 PDF.co 临时文件存储中删除任何生成的输出文件（s）。 链接过期的最大持续时间因当前订阅计划而异。
异步
 async boolean

对于在后台运行的长进程，API 将返回一个 jobId，与 JobCheck 终结点一起使用以检查进程状态并检索输出，而你可以继续执行其他任务，而无需等待此过程完成。
Profiles
 profiles string

可以使用此参数设置其他和额外的选项，以便设置自定义配置。 浏览 PDF.co 知识库（https://developer.pdf.co/api/profiles/index.html）了解配置文件示例。

返回

名称 路径 类型 说明
URL
 url string

网址
作业 ID
 jobId string

jobId
错误
 error boolean

错误
状态
 status integer

状态
Name
 name string

姓名
贷项
 credits integer

积分
remainingCredits
 remainingCredits integer

remainingCredits
持续时间
 duration integer

duration

电子表格到 HTML

操作 ID:
XLStoHTML

将 XLS/XLSX 转换为 HTML 文件。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/convert-excel/index.html#post-tag-xls-convert-to-html 。

参数

名称 密钥 必需 类型 说明
URL
 url True string

源文件的 URL。 支持 Google Drive、Dropbox 和 PDF.co 内置文件存储的链接。
工作表索引
 worksheetIndex string

设置 WorkSheet 索引（默认值为 0）。
Name
 name string

生成的输出的文件名。
过期日期
 expiration integer

设置输出链接的过期时间（默认值为 60 分钟或 1 小时），在此指定的持续时间后，将从 PDF.co 临时文件存储中删除任何生成的输出文件（s）。 链接过期的最大持续时间因当前订阅计划而异。
异步
 async boolean

对于在后台运行的长进程，API 将返回一个 jobId，与 JobCheck 终结点一起使用以检查进程状态并检索输出，而你可以继续执行其他任务，而无需等待此过程完成。
Profiles
 profiles string

可以使用此参数设置其他和额外的选项，以便设置自定义配置。 浏览 PDF.co 知识库（https://developer.pdf.co/api/profiles/index.html）了解配置文件示例。

返回

名称 路径 类型 说明
URL
 url string

网址
作业 ID
 jobId string

jobId
错误
 error boolean

错误
状态
 status integer

状态
Name
 name string

姓名
贷项
 credits integer

积分
remainingCredits
 remainingCredits integer

remainingCredits
持续时间
 duration integer

duration

电子表格到 JSON

操作 ID:
XLStoJSON

将 XLS/XLSX 转换为 JSON 文件。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/convert-excel/index.html#post-tag-xls-convert-to-json 。

参数

名称 密钥 必需 类型 说明
URL
 url True string

源文件的 URL。 支持 Google Drive、Dropbox 和 PDF.co 内置文件存储的链接。
工作表索引
 worksheetIndex string

设置 WorkSheet 索引（默认值为 0）。
Name
 name string

生成的输出的文件名。
过期日期
 expiration integer

设置输出链接的过期时间（默认值为 60 分钟或 1 小时），在此指定的持续时间后，将从 PDF.co 临时文件存储中删除任何生成的输出文件（s）。 链接过期的最大持续时间因当前订阅计划而异。
异步
 async boolean

对于在后台运行的长进程，API 将返回一个 jobId，与 JobCheck 终结点一起使用以检查进程状态并检索输出，而你可以继续执行其他任务，而无需等待此过程完成。
Profiles
 profiles string

可以使用此参数设置其他和额外的选项，以便设置自定义配置。 浏览 PDF.co 知识库（https://developer.pdf.co/api/profiles/index.html）了解配置文件示例。

返回

名称 路径 类型 说明
URL
 url string

网址
作业 ID
 jobId string

jobId
错误
 error boolean

错误
状态
 status integer

状态
Name
 name string

姓名
贷项
 credits integer

积分
remainingCredits
 remainingCredits integer

remainingCredits
持续时间
 duration integer

duration

电子表格到 TXT

操作 ID:
XLStoTXT

将 XLS/XLSX 或 CSV 转换为文本文件。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/convert-excel/index.html#post-tag-xls-convert-to-txt 。

参数

名称 密钥 必需 类型 说明
URL
 url True string

源文件的 URL。 支持 Google Drive、Dropbox 和 PDF.co 内置文件存储的链接。
工作表索引
 worksheetIndex string

设置 WorkSheet 索引（默认值为 0）。
Name
 name string

生成的输出的文件名。
过期日期
 expiration integer

设置输出链接的过期时间（默认值为 60 分钟或 1 小时），在此指定的持续时间后，将从 PDF.co 临时文件存储中删除任何生成的输出文件（s）。 链接过期的最大持续时间因当前订阅计划而异。
异步
 async boolean

对于在后台运行的长进程，API 将返回一个 jobId，与 JobCheck 终结点一起使用以检查进程状态并检索输出，而你可以继续执行其他任务，而无需等待此过程完成。
Profiles
 profiles string

可以使用此参数设置其他和额外的选项，以便设置自定义配置。 浏览 PDF.co 知识库（https://developer.pdf.co/api/profiles/index.html）了解配置文件示例。

返回

名称 路径 类型 说明
URL
 url string

网址
作业 ID
 jobId string

jobId
错误
 error boolean

错误
状态
 status integer

状态
Name
 name string

姓名
贷项
 credits integer

积分
remainingCredits
 remainingCredits integer

remainingCredits
持续时间
 duration integer

duration

电子表格到 XML

操作 ID:
XLStoXML

将 XLS/XLSX 或 CSV 转换为 XML 文件。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/convert-excel/index.html#post-tag-xls-convert-to-xml 。

参数

名称 密钥 必需 类型 说明
URL
 url True string

源文件的 URL。 支持 Google Drive、Dropbox 和 PDF.co 内置文件存储的链接。
工作表索引
 worksheetIndex string

设置 WorkSheet 索引（默认值为 0）。
Name
 name string

生成的输出的文件名。
过期日期
 expiration integer

设置输出链接的过期时间（默认值为 60 分钟或 1 小时），在此指定的持续时间后，将从 PDF.co 临时文件存储中删除任何生成的输出文件（s）。 链接过期的最大持续时间因当前订阅计划而异。
异步
 async boolean

对于在后台运行的长进程，API 将返回一个 jobId，与 JobCheck 终结点一起使用以检查进程状态并检索输出，而你可以继续执行其他任务，而无需等待此过程完成。
Profiles
 profiles string

可以使用此参数设置其他和额外的选项，以便设置自定义配置。 浏览 PDF.co 知识库（https://developer.pdf.co/api/profiles/index.html）了解配置文件示例。

返回

名称 路径 类型 说明
URL
 url string

网址
作业 ID
 jobId string

jobId
错误
 error boolean

错误
状态
 status integer

状态
Name
 name string

姓名
贷项
 credits integer

积分
remainingCredits
 remainingCredits integer

remainingCredits
持续时间
 duration integer

duration

电子邮件信息

操作 ID:
EmailDecode

获取电子邮件信息，例如发件人/收件人、主题、正文等。有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/email-send-and-decode/index.html#post-tag-email-decode 。

参数

名称 密钥 必需 类型 说明
URL
 url True string

源文件的 URL。 支持 Google Drive、Dropbox 和 PDF.co 内置文件存储的链接。
Profiles
 profiles string

使用此参数可设置用于微调和额外选项的其他配置。 浏览 PDF.co 知识库（https://developer.pdf.co/api/profiles/index.html）了解配置文件示例。
异步
 async boolean

对于在后台运行的长进程，API 将返回一个 jobId，可用于 JobCheck 终结点检查进程的状态并检索输出，同时你可以继续执行其他任务，而无需等待此过程完成。

返回

名称 路径 类型 说明
URL
 url string

网址
来自
 body.from string
发件人姓名
 body.fromName string
到
 body.to array of object
地址
 body.to.address string
Name
 body.to.Name string

Name
抄送
 body.cc array of object
地址
 body.cc.address string
Name
 body.cc.Name string

Name
bcc
 body.bcc array of object
地址
 body.bcc.address string
Name
 body.bcc.Name string

Name
发送位置
 body.sentAt string
Received At
 body.receivedAt string
Subject
 body.subject string
正文（HTML）
 body.bodyHtml string
正文（文本）
 body.bodyText string
附件计数
 body.attachmentCount integer
作业 ID
 jobId string

jobId
错误
 error boolean

错误
状态
 status integer

状态
Name
 name string

姓名
贷项
 credits integer

积分
剩余额度
 remainingCredits integer

remainingCredits
持续时间
 duration integer

duration

电子邮件附件提取

操作 ID:
EmailAttachmentExtraction

使用基本电子邮件信息提取电子邮件附件。 有关全面指南，请参阅 API 文档 https://developer.pdf.co/api/email-send-and-decode/index.html#post-tag-email-extract-attachments 。

参数

名称 密钥 必需 类型 说明
URL
 url True string

源文件的 URL。 支持 Google Drive、Dropbox 和 PDF.co 内置文件存储的链接。
Profiles
 profiles string

使用此参数可设置用于微调和额外选项的其他配置。 浏览 PDF.co 知识库（https://developer.pdf.co/api/profiles/index.html）了解配置文件示例。
异步
 async boolean

对于在后台运行的长进程，API 将返回一个 jobId，可用于 JobCheck 终结点检查进程的状态并检索输出，同时你可以继续执行其他任务，而无需等待此过程完成。

返回

名称 路径 类型 说明
URL
 url string

网址
来自
 body.from string
Subject
 body.subject string
正文（HTML）
 body.bodyHtml string
正文（文本）
 body.bodyText string
attachments
 body.attachments array of object
文件名
 body.attachments.filename string
contentid
 body.attachments.contentid string

内容 ID
网址
 body.attachments.url string

URL
filesizeinbytes
 body.attachments.filesizeinbytes integer

文件大小（以字节为单位）
作业 ID
 jobId string

jobId
错误
 error boolean

错误
状态
 status integer

状态
Name
 name string

姓名
贷项
 credits integer

积分
剩余额度
 remainingCredits integer

remainingCredits
持续时间
 duration integer

duration