PDF公司
PDF.co 是從數據提取到文檔解析器的 PDF 工具集。 生成 PDF、閱讀非結構化 PDF、填寫 PDF 表單、將文本/圖像添加到 PDF、拆分 PDF、合併 PDF、將 PDF 表格轉換為 CSV、JSON、XML 等等。
此連接器適用於以下產品和區域:
| 服務 | Class | Regions |
|---|---|---|
| 副駕駛工作室 | 進階 | 除下列區域外的所有 Power Automate 區域 : - 美國政府 (GCC) - 美國政府(海灣合作委員會高中) - 由 21Vianet 營運的中國雲 - 美國國防部 (DoD) |
| 邏輯應用程式 | 標準 | 所有 Logic Apps 區域, 但下列區域除外: - Azure Government 區域 - Azure 中國區域 - 美國國防部 (DoD) |
| Power Apps | 進階 | 除下列區域外的所有 Power Apps 區域 : - 美國政府 (GCC) - 美國政府(海灣合作委員會高中) - 由 21Vianet 營運的中國雲 - 美國國防部 (DoD) |
| Power Automate(自動化服務) | 進階 | 除下列區域外的所有 Power Automate 區域 : - 美國政府 (GCC) - 美國政府(海灣合作委員會高中) - 由 21Vianet 營運的中國雲 - 美國國防部 (DoD) |
| 連絡人 | |
|---|---|
| 名稱 | PDF.co 支持 |
| URL | https://support.bytescout.com |
| plugins@bytescout.com |
| 連接器中繼資料 | |
|---|---|
| Publisher | PDF.co |
| 網站 | https://pdf.co/ |
| 隱私策略 | https://pdf.co/pages/legal/privacy |
| 類別 | 生產力;資料 |
PDF.co 聯結器提供合併 PDF、分割 PDF、HTML 至 PDF、URL 至 PDF 和修改 PDF 的作業。 合併PDF支援將不同類型的文件合併為PDF格式。 對於修改 PDF,它支持將文本/圖像添加到 PDF 中以及填寫 PDF 表單。
先決條件
PDF.co 需要 API 金鑰來驗證其請求。
如何取得認證
PDF.co API 金鑰可以透過註冊 PDF.co 來取得 。
- 登入您的 PDF.co 帳戶 https://app.pdf.co
- 登入後,API 金鑰可在「檢視您的 API 金鑰」部分找到。
開始使用連接器
PDF.co 連接器包含下列動作。
HTML 轉 PDF
HTML to PDF 動作會將原始 HTML 轉換為 PDF 格式。 除此之外,我們還可以配置高級選項,例如輸出紙張大小、PDF 頁面方向、邊距、自定義頁眉和頁腳等。
URL 轉為 PDF
顧名思義, 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
請參閱 PDF.co 知識庫 以取得所有 QA。
正在建立連線
連接器支援下列驗證類型:
| 預設值 | 建立連線的參數。 | 所有區域 | 不可共享 |
預設
適用:所有地區
建立連線的參數。
這不是可共用的連線。 如果 Power App 與其他使用者共用,系統會明確提示其他使用者建立新連線。
| 名稱 | 類型 | Description | 為必填項目 |
|---|---|---|---|
| API 金鑰 | securestring | 此端點的 API 金鑰 | 對 |
節流限制
| 名稱 | 呼叫 | 續約期間 |
|---|---|---|
| 每個連線的 API 呼叫 | 100 | 60 秒 |
動作
CSV 中的 PDF
將 CSV 文件轉換為 PDF。 也適用於 XLS 或 XLSX 輸入。 請參閱 API 文件, https://developer.pdf.co/api/pdf-from-document/index.html#post-tag-pdf-convert-from-csv 以取得完整的指導方針。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
URL
|
url | True | string |
來源檔案的URL。 支援來自 Google Drive、Dropbox 和 PDF.co 內建檔案儲存的連結。 |
|
頁面
|
pages | string |
要處理的頁面索引(或範圍)的逗號分隔清單。 第一頁從 0(零)開始。 若要設定範圍,請使用破折號 -,例如:0,2-5,7-。 要設置從索引到最後一頁的範圍,請使用如下範圍:2-(從第 #3 頁開始,因為索引從零開始,直到文檔的 )。 對於所有頁面,只需將此參數留空即可。 範例:0,2-5,7- 表示第一頁,然後是第 3 頁到第 6 頁,然後是從第 8 頁(索引 = 7)到文件結尾的範圍。 |
|
|
名稱
|
name | string |
產生輸出的檔案名稱。 |
|
|
Expiration
|
expiration | integer |
將輸出連結的到期時間設定為分鐘(預設為 60 或 60 分鐘或 1 小時),在此指定的持續時間之後,任何產生的輸出檔案都會自動從 PDF.co 暫存檔案儲存中刪除。 連結到期的最長持續時間會根據您目前的訂閱方案而有所不同。 |
|
|
非同步
|
async | boolean |
如果長程序在背景執行,API 會設定為 true,然後會傳回 jobId,您可以搭配 JobCheck 端點使用,以檢查程序的狀態並擷取輸出,同時您可以繼續執行其他工作,而不需要等待此程序完成。 |
|
|
Profiles
|
profiles | string |
您可以使用此參數設定其他和額外的選項,以設定自訂設定。 探索 PDF.co 知識庫 (https://developer.pdf.co/api/profiles/index.html) 以取得設定檔範例。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
URL
|
url | string | |
|
工作識別碼
|
jobId | string |
jobId |
|
頁數
|
pageCount | integer |
頁數 |
|
錯誤
|
error | boolean |
錯誤 |
|
地位
|
status | integer |
狀態 |
|
名稱
|
name | string |
名稱 |
|
學分
|
credits | integer |
credits |
|
剩餘積分
|
remainingCredits | integer |
剩餘學分 |
|
持續時間
|
duration | integer |
duration |
HTML 轉 PDF
將 HTML 程式碼片段轉換為功能齊全的 PDF。 請參閱 API 文件, https://developer.pdf.co/api/pdf-to-html/index.html 以取得完整的指導方針。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
HTML
|
html | True | html |
輸入要轉換的HTML程式碼。 |
|
名稱
|
name | string |
新 PDF 檔案的基底檔案名稱。 |
|
|
邊距
|
margins | string |
使用自訂值覆寫預設邊界 (順序為 |
|
|
紙張尺寸
|
paperSize | string |
選擇 PDF 紙張尺寸。 可以是 Letter、Legal、Tabloid、Ledger、A0、A1、A2、A3、A4、A5、A6 或自定義尺寸。 自定義尺寸可以以像素(像素)、毫米或(英寸)為單位設置,寬度和高度由空間分隔,如下所示:200 300、200 像素、300 像素、200 毫米、300 厘米、20 厘米 30 厘米或 6 英寸 8 英寸。 |
|
|
導覽
|
orientation | string |
PDF 頁面方向。 |
|
|
列印背景
|
printBackground | boolean |
啟用或停用列印文件背景 |
|
|
Header
|
header | html |
設定為 HTML,以便將標頭套用至頁首處的每個頁面。 |
|
|
頁尾
|
footer | html |
設定為 HTML 以將頁尾套用至底部的每個頁面。 |
|
|
Expiration
|
expiration | integer |
將輸出連結的到期時間設定為分鐘(預設為 60 或 60 分鐘或 1 小時),在此指定的持續時間之後,任何產生的輸出檔案都會自動從 PDF.co 暫存檔案儲存中刪除。 連結到期的最長持續時間會根據您目前的訂閱方案而有所不同。 |
|
|
Profiles
|
profiles | string |
此參數可用來設定其他組態以進行微調,並啟用更多選項。 請造訪 PDF.co 知識庫 (https://developer.pdf.co/api/profiles/index.html) 以取得設定檔範例等。 |
|
|
非同步
|
async | boolean |
如果長程序在背景執行,API 會設定為 true,然後會傳回 jobId,您可以搭配 JobCheck 端點使用,以檢查程序的狀態並擷取輸出,同時您可以繼續執行其他工作,而不需要等待此程序完成。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
URL
|
url | string |
輸出文件 URL。 |
|
工作識別碼
|
jobId | string |
jobId |
|
頁數
|
pageCount | integer |
輸出文件中的頁數。 |
|
錯誤
|
error | boolean |
指出作業是否成功。 |
|
狀態代碼
|
status | integer |
HTTP 回應的狀態碼 |
|
名稱
|
name | string |
輸出文件名稱 |
|
學分
|
credits | integer |
PDF.co 用於此請求的積分 |
|
持續時間
|
duration | integer |
請求執行持續時間 |
|
剩餘積分
|
remainingCredits | integer |
PDF.co 帳戶剩餘點數 |
PDF 信息閱讀器
獲取有關 PDF 文檔、其屬性和安全權限的詳細信息。 請參閱 API 文件, https://developer.pdf.co/api/pdf-info-reader/index.html 以取得完整的指導方針。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
URL
|
url | True | string |
來源檔案的URL。 支援來自 Google Drive、Dropbox 和 PDF.co 內建檔案儲存的連結。 |
|
非同步
|
async | boolean |
如果要在背景執行長程序,API 會傳回 jobId,您可以搭配 JobCheck 模組使用該 jobId 來檢查程序的狀態並擷取輸出,同時您可以繼續執行其他工作,而不需要等待此程序完成。 |
|
|
密碼
|
password | string |
PDF檔案的密碼 |
|
|
Profiles
|
profiles | string |
使用此引數來設定微調和額外選項的其他設定,探索 PDF.co 知識庫(https://developer.pdf.co/api/profiles/index.html)以取得設定檔範例。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
JobId
|
jobId | string |
jobId |
|
URL
|
url | string |
url |
|
頁數
|
info.PageCount | integer |
頁數 |
|
作者
|
info.Author | string |
作者 |
|
Title
|
info.Title | string |
Title |
|
Producer
|
info.Producer | string |
Producer |
|
主旨
|
info.Subject | string |
主旨 |
|
CreationDate
|
info.CreationDate | string |
CreationDate |
|
Bookmarks
|
info.Bookmarks | string |
Bookmarks |
|
關鍵字
|
info.Keywords | string |
關鍵字 |
|
Creator
|
info.Creator | string |
Creator |
|
已加密
|
info.Encrypted | boolean |
已加密 |
|
密碼保護
|
info.PasswordProtected | boolean |
密碼保護 |
|
IsEmpty
|
info.PageRectangle.Location.IsEmpty | boolean |
IsEmpty |
|
|
info.PageRectangle.Location.X | float |
X |
|
|
info.PageRectangle.Location.Y | float |
是 |
|
大小
|
info.PageRectangle.Size | string |
大小 |
|
|
info.PageRectangle.X | float |
X |
|
|
info.PageRectangle.Y | float |
是 |
|
|
info.PageRectangle.Width | float |
寬度 |
|
|
info.PageRectangle.Height | float |
高度 |
|
|
info.PageRectangle.Left | float |
左側 |
|
|
info.PageRectangle.Top | float |
前幾個 |
|
|
info.PageRectangle.Right | float |
正確 |
|
|
info.PageRectangle.Bottom | float |
靠下 |
|
IsEmpty
|
info.PageRectangle.IsEmpty | boolean |
IsEmpty |
|
修改日期
|
info.ModificationDate | string |
修改日期 |
|
附件數量
|
info.AttachmentCount | integer |
附件數量 |
|
EncryptionAlgorithm
|
info.EncryptionAlgorithm | string |
EncryptionAlgorithm |
|
許可列印
|
info.PermissionPrinting | boolean |
許可列印 |
|
權限修改文件
|
info.PermissionModifyDocument | boolean |
權限修改文件 |
|
許可內容擷取
|
info.PermissionContentExtraction | boolean |
許可內容擷取 |
|
PermissionModify註解
|
info.PermissionModifyAnnotations | boolean |
PermissionModify註解 |
|
許可填寫表單
|
info.PermissionFillForms | boolean |
許可填寫表單 |
|
許可協助工具
|
info.PermissionAccessibility | boolean |
許可協助工具 |
|
許可組裝
|
info.PermissionAssemble | boolean |
許可組裝 |
|
許可高品質列印
|
info.PermissionHighQualityPrint | boolean |
許可高品質列印 |
|
錯誤
|
error | boolean |
錯誤 |
|
地位
|
status | integer |
狀態 |
|
學分
|
credits | integer |
credits |
|
剩餘積分
|
remainingCredits | integer |
剩餘學分 |
|
持續時間
|
duration | integer |
duration |
PDF 刪除安全性
從現有的 PDF 檔案中移除密碼和安全性。 請參閱 API 文件, https://developer.pdf.co/api/password-and-security/index.html#post-tag-pdf-security-remove 以取得完整的指導方針。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
URL
|
url | True | string |
來源檔案的URL。 支援來自 Google Drive、Dropbox 和 PDF.co 內建檔案儲存的連結。 |
|
密碼
|
password | True | string |
用於開啟檔案和移除安全性功能的擁有者/使用者密碼。 |
|
名稱
|
name | string |
產生輸出的檔案名稱。 |
|
|
Expiration
|
expiration | integer |
將輸出連結的到期時間設定為分鐘(預設為 60 或 60 分鐘或 1 小時),在此指定的持續時間之後,任何產生的輸出檔案都會自動從 PDF.co 暫存檔案儲存中刪除。 連結到期的最長持續時間會根據您目前的訂閱方案而有所不同。 |
|
|
非同步
|
async | boolean |
如果長程序在背景執行,API 會設定為 true,然後會傳回 jobId,您可以搭配 JobCheck 端點使用,以檢查程序的狀態並擷取輸出,同時您可以繼續執行其他工作,而不需要等待此程序完成。 |
|
|
Profiles
|
profiles | string |
您可以使用此參數設定其他和額外的選項,以設定自訂設定。 探索 PDF.co 知識庫 (https://developer.pdf.co/api/profiles/index.html) 以取得設定檔範例。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
URL
|
url | string | |
|
工作識別碼
|
jobId | string |
jobId |
|
頁數
|
pageCount | integer |
頁數 |
|
錯誤
|
error | boolean |
錯誤 |
|
地位
|
status | integer |
狀態 |
|
名稱
|
name | string |
名稱 |
|
學分
|
credits | integer |
credits |
|
剩餘積分
|
remainingCredits | integer |
剩餘學分 |
|
持續時間
|
duration | integer |
duration |
PDF 刪除頁面
刪除 PDF 中的頁面。 請參閱 API 文件, https://developer.pdf.co/api/pdf-delete-pages/index.html 以取得完整的指導方針。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
URL
|
url | True | string |
來源檔案的URL。 支援來自 Google Drive、Dropbox 和 PDF.co 內建檔案儲存的連結。 |
|
頁面
|
pages | string |
要處理的頁面索引(或範圍)的逗號分隔清單。 第一頁從 0(零)開始。 若要設定範圍,請使用破折號 -,例如:0,2-5,7-。 要設置從索引到最後一頁的範圍,請使用如下範圍:2-(從第 #3 頁開始,因為索引從零開始,直到文檔的 )。 對於所有頁面,只需將此參數留空即可。 範例:0,2-5,7- 表示第一頁,然後是第 3 頁到第 6 頁,然後是從第 8 頁(索引 = 7)到文件結尾的範圍。 |
|
|
名稱
|
name | string |
產生輸出的檔案名稱 |
|
|
Expiration
|
expiration | integer |
將輸出連結的到期時間設定為分鐘(預設為 60 或 60 分鐘或 1 小時),在此指定的持續時間之後,任何產生的輸出檔案都會自動從 PDF.co 暫存檔案儲存中刪除。 連結到期的最長持續時間會根據您目前的訂閱方案而有所不同。 |
|
|
Profiles
|
profiles | string |
使用此參數可設定微調和額外選項的其他配置。 探索 PDF.co 知識庫 (https://developer.pdf.co/api/profiles/index.html) 以取得設定檔範例。 |
|
|
非同步
|
async | boolean |
將 async 設定為 true 以在背景執行長進程,API 接著會傳回 jobId,您可以搭配 JobCheck 端點使用,以檢查進程的狀態並擷取輸出,同時您可以繼續執行其他工作,而不需要等待此進程完成。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
URL
|
url | string |
url |
|
工作識別碼
|
jobId | string |
jobId |
|
頁數
|
pageCount | integer |
頁數 |
|
錯誤
|
error | boolean |
錯誤 |
|
地位
|
status | integer |
狀態 |
|
名稱
|
name | string |
名稱 |
|
學分
|
credits | integer |
credits |
|
剩餘積分
|
remainingCredits | integer |
剩餘學分 |
|
持續時間
|
duration | integer |
duration |
PDF 壓縮和優化
優化 PDF 文檔以減小其大小。 請參閱 API 文件, https://developer.pdf.co/api/pdf-optimize/index.html 以取得完整的指導方針。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
URL
|
url | True | string |
來源檔案的URL。 支援來自 Google Drive、Dropbox 和 PDF.co 內建檔案儲存的連結。 |
|
名稱
|
name | string |
產生輸出的檔案名稱 |
|
|
Expiration
|
expiration | integer |
將輸出連結的到期時間設定為分鐘(預設為 60 或 60 分鐘或 1 小時),在此指定的持續時間之後,任何產生的輸出檔案都會自動從 PDF.co 暫存檔案儲存中刪除。 連結到期的最長持續時間會根據您目前的訂閱方案而有所不同。 |
|
|
密碼
|
password | string |
PDF檔案的密碼 |
|
|
Profiles
|
profiles | string |
使用此參數可設定微調和額外選項的其他配置。 探索 PDF.co 知識庫 (https://developer.pdf.co/api/profiles/index.html) 以取得設定檔範例。 |
|
|
非同步
|
async | boolean |
將 async 設定為 true 以在背景執行長進程,API 接著會傳回 jobId,您可以搭配 JobCheck 端點使用,以檢查進程的狀態並擷取輸出,同時您可以繼續執行其他工作,而不需要等待此進程完成。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
URL
|
url | string |
url |
|
工作識別碼
|
jobId | string |
jobId |
|
頁數
|
pageCount | integer |
頁數 |
|
錯誤
|
error | boolean |
錯誤 |
|
地位
|
status | integer |
狀態 |
|
名稱
|
name | string |
名稱 |
|
學分
|
credits | integer |
credits |
|
剩餘積分
|
remainingCredits | integer |
剩餘學分 |
|
持續時間
|
duration | integer |
duration |
PDF 尋找表格
AI 驅動的文件分析可以掃描您的文件中的表格,並傳回頁面上的表格陣列,其中包含這些表格中偵測到的列的座標和資訊。 請參閱 API 文件, https://developer.pdf.co/api/pdf-find/index.html#post-tag-pdf-find-table 以取得完整的指導方針。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
URL
|
url | True | string |
來源檔案的URL。 支援來自 Google Drive、Dropbox 和 PDF.co 內建檔案儲存的連結。 |
|
頁面
|
pages | string |
要處理的頁面索引(或範圍)的逗號分隔清單。 重要提示:第一頁從 0(零)開始。 若要設定範圍,請使用破折號 -,例如:0,2-5,7-。 要設置從索引到最後一頁的範圍,請使用如下範圍:2-(從第 #3 頁開始,因為索引從零開始,直到文檔的 )。 對於所有頁面,只需將此參數留空即可。 範例: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
|
expiration | integer |
將輸出連結的到期時間設定為分鐘(預設為 60 或 60 分鐘或 1 小時),在此指定的持續時間之後,任何產生的輸出檔案都會自動從 PDF.co 暫存檔案儲存中刪除。 連結到期的最長持續時間會根據您目前的訂閱方案而有所不同。 |
|
|
非同步
|
async | boolean |
將 async 設定為 true 以在背景執行長進程,API 接著會傳回 jobId,您可以搭配 /job/check 端點使用,以檢查進程的狀態並擷取輸出,同時您可以繼續執行其他工作,而不需要等待此進程完成。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
工作識別碼
|
jobId | string |
jobId |
|
URL
|
url | string |
url |
|
tables
|
body.tables | array of object |
tables |
|
頁面索引
|
body.tables.PageIndex | integer |
頁面索引 |
|
|
body.tables.X | float |
X |
|
是
|
body.tables.Y | float |
是 |
|
寬度
|
body.tables.Width | float |
寬度 |
|
|
body.tables.Height | float |
高度 |
|
Columns
|
body.tables.Columns | array of float |
Columns |
|
矩形
|
body.tables.rect | string |
直截了當的 |
|
頁數
|
pageCount | integer |
頁數 |
|
錯誤
|
error | boolean |
錯誤 |
|
地位
|
status | integer |
狀態 |
|
學分
|
credits | integer |
學分 |
|
剩餘積分
|
remainingCredits | integer |
剩餘學分 |
|
持續時間
|
duration | integer |
duration |
PDF 搜尋和取代文字
透過搜尋特定文字並將其替換為新文字來修改 PDF 檔案。 請參閱 API 文件, https://developer.pdf.co/api/pdf-search-and-replace-text/index.html#post-tag-pdf-edit-replace-text 以取得完整的指導方針。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
URL
|
url | True | string |
來源檔案的URL。 支援來自 Google Drive、Dropbox 和 PDF.co 內建檔案儲存的連結。 |
|
搜尋字串
|
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 頁開始,因為索引從零開始,直到文檔的 )。 對於所有頁面,只需將此參數留空即可。 範例:0,2-5,7- 表示第一頁,然後是第 3 頁到第 6 頁,然後是從第 8 頁(索引 = 7)到文件結尾的範圍。 |
|
|
密碼
|
password | string |
PDF 檔案的密碼 |
|
|
名稱
|
name | string |
產生輸出的檔案名稱 |
|
|
Expiration
|
expiration | integer |
將輸出連結的到期時間設定為分鐘(預設為 60 或 60 分鐘或 1 小時),在此指定的持續時間之後,任何產生的輸出檔案都會自動從 PDF.co 暫存檔案儲存中刪除。 連結到期的最長持續時間會根據您目前的訂閱方案而有所不同。 |
|
|
非同步
|
async | boolean |
將 async 設定為 true 以在背景執行長進程,API 隨後會傳回一個 jobId,您可以將其與 JobCheck 模組一起使用,以檢查進程的狀態並擷取輸出,同時您可以繼續執行其他任務,而無需等待此進程完成。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
URL
|
url | string |
url |
|
頁數
|
pageCount | integer | |
|
工作識別碼
|
jobId | string |
jobId |
|
錯誤
|
error | boolean |
錯誤 |
|
地位
|
status | integer |
狀態 |
|
名稱
|
name | string |
名稱 |
|
學分
|
credits | integer |
credits |
|
剩餘積分
|
remainingCredits | integer |
剩餘學分 |
|
持續時間
|
duration | integer |
PDF 搜尋文字
搜索 PDF 中的文本並獲取坐標。 支援正規表示式。 請參閱 API 文件, https://developer.pdf.co/api/pdf-find/index.html 以取得完整的指導方針。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
URL
|
url | True | string |
來源檔案的URL。 支援來自 Google Drive、Dropbox 和 PDF.co 內建檔案儲存的連結。 |
|
搜尋字串
|
searchString | True | string |
如果您將「Regex Search」參數設定為true,則要搜尋的文字可以支援正則運算式。 |
|
是正則表達式搜索
|
regexSearch | boolean | ||
|
頁面
|
pages | string |
要處理的頁面索引(或範圍)的逗號分隔清單。 重要提示:第一頁從 0(零)開始。 若要設定範圍,請使用破折號 -,例如:0,2-5,7-。 要設置從索引到最後一頁的範圍,請使用如下範圍:2-(從第 #3 頁開始,因為索引從零開始,直到文檔的 )對於所有頁面,只需將此參數留空即可。 範例:0,2-5,7-表示第一頁,然後是第3頁到第6頁,然後是從第8頁(索引=7)到文件結尾的範圍,輸入必須是字串格式。 |
|
|
內嵌
|
inline | boolean | ||
|
單字匹配模式
|
wordMatchingMode | string |
值可以是 'SmartMatch'、'ExactMatch' 或 'None'。 |
|
|
密碼
|
password | string |
PDF檔案的密碼 |
|
|
非同步
|
async | boolean |
將 async 設定為 true 以在背景執行長進程,API 隨後會傳回一個 jobId,您可以將其與 JobCheck 模組一起使用,以檢查進程的狀態並擷取輸出,同時您可以繼續執行其他任務,而無需等待此進程完成。 |
|
|
Profiles
|
profiles | string |
使用此參數可設定微調和額外選項的其他配置。 探索 PDF.co 知識庫 (https://developer.pdf.co/api/profiles/index.html) 以取得設定檔範例。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
body
|
body | array of object |
body |
|
文字
|
body.text | string |
收發簡訊 |
|
左側
|
body.left | float |
left |
|
前幾個
|
body.top | float |
top |
|
寬度
|
body.width | float |
寬度 |
|
高度
|
body.height | float |
height |
|
頁面索引
|
body.pageIndex | integer |
頁面索引 |
|
URL
|
url | string |
url |
|
工作識別碼
|
jobId | string | |
|
頁數
|
pageCount | integer |
頁數 |
|
錯誤
|
error | boolean |
錯誤 |
|
地位
|
status | integer |
狀態 |
|
學分
|
credits | integer |
credits |
|
剩餘積分
|
remainingCredits | integer |
剩餘學分 |
|
持續時間
|
duration | integer |
duration |
PDF 搜索並將文本替換為圖像
將 PDF 文件中的特定文字取代為影像。 請參閱 API 文件, https://developer.pdf.co/api/pdf-search-and-replace-text/index.html#post-tag-pdf-edit-replace-text-with-image 以取得完整的指導方針。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
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 頁開始,因為索引從零開始,直到文檔的 )。 對於所有頁面,只需將此參數留空即可。 範例:0,2-5,7- 表示第一頁,然後是第 3 頁到第 6 頁,然後是從第 8 頁(索引 = 7)到文件結尾的範圍。 |
|
|
非同步
|
async | boolean |
將 async 設定為 true 以在背景執行長進程,API 隨後將傳回一個 jobId,您可以將其與 Job Check 模組一起使用來檢查進程的狀態並檢索輸出,同時您可以繼續執行其他任務,而無需等待此進程完成。 |
|
|
是否啟用了正則表達式?
|
regex | boolean | ||
|
更換限額
|
replacementLimit | integer |
限制每個項目的搜索和替換次數。 預設值為 0,這表示無限制的搜尋和取代,因此每個找到的出現項目都會被取代。 |
|
|
Expiration
|
expiration | integer |
將輸出連結的到期時間設定為分鐘(預設為 60 或 60 分鐘或 1 小時),在此指定的持續時間之後,任何產生的輸出檔案都會自動從 PDF.co 暫存檔案儲存中刪除。 連結到期的最長持續時間會根據您目前的訂閱方案而有所不同。 |
|
|
密碼
|
password | string |
PDF檔案的密碼 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
工作識別碼
|
jobId | string |
jobId |
|
URL
|
url | string |
url |
|
頁數
|
pageCount | integer |
頁數 |
|
錯誤
|
error | boolean |
錯誤 |
|
地位
|
status | integer |
狀態 |
|
名稱
|
name | string |
名稱 |
|
學分
|
credits | integer |
credits |
|
剩餘積分
|
remainingCredits | integer |
剩餘學分 |
|
持續時間
|
duration | integer |
duration |
PDF 搜索和刪除 PDF 中的文本
搜尋 PDF 中的文字並從 PDF 中移除找到的文字。 請參閱 API 文件, https://developer.pdf.co/api/pdf-search-and-delete-text/index.html 以取得完整的指導方針。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
URL
|
url | True | string |
來源檔案的URL。 支援來自 Google Drive、Dropbox 和 PDF.co 內建檔案儲存的連結。 |
|
搜尋字串
|
searchStrings | True | array of string |
搜尋字串 |
|
區分大小寫
|
caseSensitive | boolean | ||
|
是否啟用了正則表達式?
|
regex | boolean |
設定為 true 以對搜尋字串使用正規表示式。 |
|
|
更換限額
|
replacementLimit | integer |
限制每個項目的搜索和替換次數。 預設值為 0,這表示無限制的搜尋和取代,因此每個找到的出現項目都會被取代。 |
|
|
Expiration
|
expiration | integer |
將輸出連結的到期時間設定為分鐘(預設為 60 或 60 分鐘或 1 小時),在此指定的持續時間之後,任何產生的輸出檔案都會自動從 PDF.co 暫存檔案儲存中刪除。 連結到期的最長持續時間會根據您目前的訂閱方案而有所不同。 |
|
|
名稱
|
name | string |
產生輸出的檔案名稱 |
|
|
密碼
|
password | string |
PDF檔案的密碼 |
|
|
頁面
|
pages | string |
要處理的頁面索引(或範圍)的逗號分隔清單。 第一頁從 0(零)開始。 若要設定範圍,請使用破折號 -,例如:0,2-5,7-。 要設置從索引到最後一頁的範圍,請使用如下範圍:2-(從第 #3 頁開始,因為索引從零開始,直到文檔的 )。 對於所有頁面,只需將此參數留空即可。 範例:0,2-5,7- 表示第一頁,然後是第 3 頁到第 6 頁,然後是從第 8 頁(索引 = 7)到文件結尾的範圍。 |
|
|
Profiles
|
profiles | string |
使用此參數可設定微調和額外選項的其他配置。 探索 PDF.co 知識庫 (https://developer.pdf.co/api/profiles/index.html) 以取得設定檔範例。 |
|
|
非同步
|
async | boolean |
將 async 設定為 true 以在背景執行長進程,API 接著會傳回 jobId,您可以搭配 JobCheck 端點使用,以檢查進程的狀態並擷取輸出,同時您可以繼續執行其他工作,而不需要等待此進程完成。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
URL
|
url | string |
url |
|
工作識別碼
|
jobId | string |
jobId |
|
頁數
|
pageCount | integer |
頁數 |
|
錯誤
|
error | boolean |
錯誤 |
|
地位
|
status | integer |
狀態 |
|
名稱
|
name | string |
名稱 |
|
學分
|
credits | integer |
credits |
|
剩餘積分
|
remainingCredits | integer |
剩餘學分 |
|
持續時間
|
duration | integer |
duration |
PDF 新增安全性
將密碼和安全性限制新增至現有 PDF。 請參閱 API 文件, https://developer.pdf.co/api/password-and-security/index.html#post-tag-pdf-security-add 以取得完整的指導方針。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
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 | string |
產生輸出的檔案名稱。 |
|
|
Expiration
|
expiration | integer |
將輸出連結的到期時間設定為分鐘(預設為 60 或 60 分鐘或 1 小時),在此指定的持續時間之後,任何產生的輸出檔案都會自動從 PDF.co 暫存檔案儲存中刪除。 連結到期的最長持續時間會根據您目前的訂閱方案而有所不同。 |
|
|
非同步
|
async | boolean |
如果長程序在背景執行,API 會設定為 true,然後會傳回 jobId,您可以搭配 JobCheck 端點使用,以檢查程序的狀態並擷取輸出,同時您可以繼續執行其他工作,而不需要等待此程序完成。 |
|
|
Profiles
|
profiles | string |
您可以使用此參數設定其他和額外的選項,以設定自訂設定。 探索 PDF.co 知識庫 (https://developer.pdf.co/api/profiles/index.html) 以取得設定檔範例。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
URL
|
url | string | |
|
工作識別碼
|
jobId | string |
jobId |
|
頁數
|
pageCount | integer |
頁數 |
|
錯誤
|
error | boolean |
錯誤 |
|
地位
|
status | integer |
狀態 |
|
名稱
|
name | string |
名稱 |
|
學分
|
credits | integer |
credits |
|
剩餘積分
|
remainingCredits | integer |
剩餘學分 |
|
持續時間
|
duration | integer |
duration |
PDF 表單資訊閱讀器
獲取有關 PDF 表單文件中可填寫字段的信息。 請參閱 API 文件, https://developer.pdf.co/api/pdf-forms-info-reader/index.html 以取得完整的指導方針。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
URL
|
url | True | string |
來源檔案的URL。 支援來自 Google Drive、Dropbox 和 PDF.co 內建檔案儲存的連結。 |
|
非同步
|
async | boolean |
如果要在背景執行長程序,API 會傳回 jobId,您可以搭配 JobCheck 模組使用該 jobId 來檢查程序的狀態並擷取輸出,同時您可以繼續執行其他工作,而不需要等待此程序完成。 |
|
|
密碼
|
password | string |
PDF檔案的密碼 |
|
|
Profiles
|
profiles | string |
使用此引數來設定微調和額外選項的其他設定,探索 PDF.co 知識庫(https://developer.pdf.co/api/profiles/index.html)以取得設定檔範例。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
JobId
|
jobId | string |
jobId |
|
URL
|
url | string |
url |
|
頁數
|
info.PageCount | integer |
頁數 |
|
作者
|
info.Author | string |
作者 |
|
Title
|
info.Title | string |
Title |
|
Producer
|
info.Producer | string |
Producer |
|
主旨
|
info.Subject | string |
主旨 |
|
CreationDate
|
info.CreationDate | string |
CreationDate |
|
Bookmarks
|
info.Bookmarks | string |
Bookmarks |
|
關鍵字
|
info.Keywords | string |
關鍵字 |
|
Creator
|
info.Creator | string |
Creator |
|
已加密
|
info.Encrypted | boolean |
已加密 |
|
密碼保護
|
info.PasswordProtected | boolean |
密碼保護 |
|
IsEmpty
|
info.PageRectangle.Location.IsEmpty | boolean |
IsEmpty |
|
X
|
info.PageRectangle.Location.X | float |
X |
|
是
|
info.PageRectangle.Location.Y | float |
是 |
|
大小
|
info.PageRectangle.Size | string |
大小 |
|
X
|
info.PageRectangle.X | float |
X |
|
是
|
info.PageRectangle.Y | float |
是 |
|
寬度
|
info.PageRectangle.Width | float |
寬度 |
|
|
info.PageRectangle.Height | float |
高度 |
|
|
info.PageRectangle.Left | float |
左側 |
|
前幾個
|
info.PageRectangle.Top | float |
前幾個 |
|
正確
|
info.PageRectangle.Right | float |
正確 |
|
|
info.PageRectangle.Bottom | float |
靠下 |
|
IsEmpty
|
info.PageRectangle.IsEmpty | boolean |
IsEmpty |
|
修改日期
|
info.ModificationDate | string |
修改日期 |
|
附件計數
|
info.AttachmentCount | integer |
附件數量 |
|
EncryptionAlgorithm
|
info.EncryptionAlgorithm | string |
EncryptionAlgorithm |
|
許可列印
|
info.PermissionPrinting | boolean |
許可列印 |
|
權限修改文件
|
info.PermissionModifyDocument | boolean |
權限修改文件 |
|
許可內容擷取
|
info.PermissionContentExtraction | boolean |
許可內容擷取 |
|
PermissionModify註解
|
info.PermissionModifyAnnotations | boolean |
PermissionModify註解 |
|
許可填寫表單
|
info.PermissionFillForms | boolean |
許可填寫表單 |
|
許可協助工具
|
info.PermissionAccessibility | boolean |
許可協助工具 |
|
許可組裝
|
info.PermissionAssemble | boolean |
許可組裝 |
|
許可高品質列印
|
info.PermissionHighQualityPrint | boolean |
許可高品質列印 |
|
自訂屬性
|
info.CustomProperties | array of object |
自訂屬性 |
|
Key
|
info.CustomProperties.Key | string |
Key |
|
價值觀
|
info.CustomProperties.Value | string |
價值觀 |
|
Fields
|
info.FieldsInfo.Fields | array of object |
Fields |
|
頁面索引
|
info.FieldsInfo.Fields.PageIndex | integer |
頁面索引 |
|
類型
|
info.FieldsInfo.Fields.Type | string |
類型 |
|
欄位名稱
|
info.FieldsInfo.Fields.FieldName | string |
欄位名稱 |
|
AltFieldName
|
info.FieldsInfo.Fields.AltFieldName | string |
AltFieldName |
|
價值觀
|
info.FieldsInfo.Fields.Value | string |
價值觀 |
|
左側
|
info.FieldsInfo.Fields.Left | float |
左側 |
|
前幾個
|
info.FieldsInfo.Fields.Top | float |
前幾個 |
|
寬度
|
info.FieldsInfo.Fields.Width | float |
寬度 |
|
高度
|
info.FieldsInfo.Fields.Height | float |
高度 |
|
錯誤
|
error | boolean |
錯誤 |
|
地位
|
status | integer |
狀態 |
|
學分
|
credits | integer |
credits |
|
剩餘積分
|
remainingCredits | integer |
剩餘學分 |
|
持續時間
|
duration | integer |
duration |
PDF 轉 CSV
將 PDF 和掃描影像轉換為具有佈局、列、行和表格的 CSV 表示。 請參閱 API 文件, https://developer.pdf.co/api/pdf-to-csv/index.html 以取得完整的指導方針。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
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(任意組合)。 |
|
|
內嵌
|
inline | boolean | ||
|
打開
|
unwrap | string |
啟用 lineGrouping 時,將線條展開為表格儲存格內的單一線。 |
|
|
頁面
|
pages | string |
要處理的頁面索引(或範圍)的逗號分隔清單。 第一頁從 0(零)開始。 若要設定範圍,請使用破折號 -,例如:0,2-5,7-。 要設置從索引到最後一頁的範圍,請使用如下範圍:2-(從第 #3 頁開始,因為索引從零開始,直到文檔的 )。 對於所有頁面,只需將此參數留空即可。 範例: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 會設定為 true,然後會傳回 jobId,您可以搭配 JobCheck 端點使用,以檢查程序的狀態並擷取輸出,同時您可以繼續執行其他工作,而不需要等待此程序完成。 |
|
|
名稱
|
name | string |
產生輸出的檔案名稱 |
|
|
線分組
|
lineGrouping | string |
表格儲存格內的行分組。 設定為 1 以啟用分組。 |
|
|
Expiration
|
expiration | integer |
將輸出連結的到期時間設定為分鐘(預設為 60 或 60 分鐘或 1 小時),在此指定的持續時間之後,任何產生的輸出檔案都會自動從 PDF.co 暫存檔案儲存中刪除。 連結到期的最長持續時間會根據您目前的訂閱方案而有所不同。 |
|
|
Profiles
|
profiles | string |
此參數可用來設定其他組態以進行微調,並啟用更多選項。 請造訪 PDF.co 知識庫 (https://developer.pdf.co/api/profiles/index.html) 以取得設定檔範例等。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
身體
|
body | string |
body |
|
URL
|
url | string |
url |
|
工作識別碼
|
jobId | string |
jobId |
|
錯誤
|
error | boolean |
錯誤 |
|
地位
|
status | integer |
狀態 |
|
名稱
|
name | string |
名稱 |
|
學分
|
credits | integer |
credits |
|
剩餘學分
|
remainingCredits | integer |
剩餘學分 |
|
持續時間
|
duration | integer |
duration |
PDF 轉 JPG
PDF 到 JPG 的轉換。 高品質渲染。 也非常適合縮略圖生成和預覽。 請參閱 API 文件, https://developer.pdf.co/api/pdf-to-image/index.html#post-tag-pdf-convert-to-jpg 以取得完整的指導方針。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
URL
|
url | True | string |
來源檔案的URL。 支援來自 Google Drive、Dropbox 和 PDF.co 內建檔案儲存的連結。 |
|
內嵌
|
inline | boolean |
內嵌 |
|
|
頁面
|
pages | string |
要處理的頁面索引(或範圍)的逗號分隔清單。 第一頁從 0(零)開始。 若要設定範圍,請使用破折號 -,例如:0,2-5,7-。 要設置從索引到最後一頁的範圍,請使用如下範圍:2-(從第 #3 頁開始,因為索引從零開始,直到文檔的 )。 對於所有頁面,只需將此參數留空即可。 範例: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
|
expiration | integer |
將輸出連結的到期時間設定為分鐘(預設為 60 或 60 分鐘或 1 小時),在此指定的持續時間之後,任何產生的輸出檔案都會自動從 PDF.co 暫存檔案儲存中刪除。 連結到期的最長持續時間會根據您目前的訂閱方案而有所不同。 |
|
|
非同步
|
async | boolean |
如果長程序在背景執行,API 會設定為 true,然後會傳回 jobId,您可以搭配 JobCheck 端點使用,以檢查程序的狀態並擷取輸出,同時您可以繼續執行其他工作,而不需要等待此程序完成。 |
|
|
Profiles
|
profiles | string |
您可以使用此參數設定其他和額外的選項,以設定自訂設定。 探索 PDF.co 知識庫 (https://developer.pdf.co/api/profiles/index.html) 以取得設定檔範例。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
網址
|
urls | array of string |
網址 |
|
工作識別碼
|
jobId | string |
jobId |
|
頁數
|
pageCount | integer |
頁數 |
|
錯誤
|
error | boolean |
錯誤 |
|
地位
|
status | integer |
狀態 |
|
名稱
|
name | string |
名稱 |
|
學分
|
credits | integer |
credits |
|
剩餘積分
|
remainingCredits | integer |
剩餘學分 |
|
持續時間
|
duration | integer |
duration |
PDF 轉 JSON
將 PDF 和掃描圖像轉換為 JSON 表示,並保留文本、字體、圖像、矢量和格式。 請參閱 API 文件, https://developer.pdf.co/api/pdf-to-json/index.html 以取得完整的指導方針。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
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(任意組合)。 |
|
|
內嵌
|
inline | boolean | ||
|
打開
|
unwrap | string |
啟用 lineGrouping 時,將線條展開為表格儲存格內的單一線。 |
|
|
頁面
|
pages | string |
要處理的頁面索引(或範圍)的逗號分隔清單。 第一頁從 0(零)開始。 若要設定範圍,請使用破折號 -,例如:0,2-5,7-。 要設置從索引到最後一頁的範圍,請使用如下範圍:2-(從第 #3 頁開始,因為索引從零開始,直到文檔的 )。 對於所有頁面,只需將此參數留空即可。 範例: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 會設定為 true,然後會傳回 jobId,您可以搭配 JobCheck 端點使用,以檢查程序的狀態並擷取輸出,同時您可以繼續執行其他工作,而不需要等待此程序完成。 |
|
|
名稱
|
name | string |
產生輸出的檔案名稱 |
|
|
線分組
|
lineGrouping | string |
表格儲存格內的行分組。 設定為 1 以啟用分組。 |
|
|
Expiration
|
expiration | integer |
將輸出連結的到期時間設定為分鐘(預設為 60 或 60 分鐘或 1 小時),在此指定的持續時間之後,任何產生的輸出檔案都會自動從 PDF.co 暫存檔案儲存中刪除。 連結到期的最長持續時間會根據您目前的訂閱方案而有所不同。 |
|
|
Profiles
|
profiles | string |
此參數可用來設定其他組態以進行微調,並啟用更多選項。 請造訪 PDF.co 知識庫 (https://developer.pdf.co/api/profiles/index.html) 以取得設定檔範例等。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
身體
|
body | object |
body |
|
URL
|
url | string |
url |
|
工作識別碼
|
jobId | string |
jobId |
|
頁數
|
pageCount | integer |
頁數 |
|
錯誤
|
error | boolean |
錯誤 |
|
地位
|
status | integer |
狀態 |
|
名稱
|
name | string |
名稱 |
|
學分
|
credits | integer |
credits |
|
剩餘學分
|
remainingCredits | integer |
剩餘學分 |
|
持續時間
|
duration | integer |
duration |
PDF 轉 JSON(AI 驅動)
將 PDF 和掃描圖像轉換為 JSON 表示,並保留文本、字體、圖像、矢量和格式。 請參閱 API 文件, https://developer.pdf.co/api/pdf-to-json/index.html#post-tag-pdf-convert-to-json-meta 以取得完整的指導方針。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
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(任意組合)。 |
|
|
內嵌
|
inline | boolean | ||
|
打開
|
unwrap | string |
啟用 lineGrouping 時,將線條展開為表格儲存格內的單一線。 |
|
|
頁面
|
pages | string |
要處理的頁面索引(或範圍)的逗號分隔清單。 第一頁從 0(零)開始。 若要設定範圍,請使用破折號 -,例如:0,2-5,7-。 要設置從索引到最後一頁的範圍,請使用如下範圍:2-(從第 #3 頁開始,因為索引從零開始,直到文檔的 )。 對於所有頁面,只需將此參數留空即可。 範例: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 會設定為 true,然後會傳回 jobId,您可以搭配 JobCheck 端點使用,以檢查程序的狀態並擷取輸出,同時您可以繼續執行其他工作,而不需要等待此程序完成。 |
|
|
名稱
|
name | string |
產生輸出的檔案名稱 |
|
|
線分組
|
lineGrouping | string |
表格儲存格內的行分組。 設定為 1 以啟用分組。 |
|
|
Expiration
|
expiration | integer |
將輸出連結的到期時間設定為分鐘(預設為 60 或 60 分鐘或 1 小時),在此指定的持續時間之後,任何產生的輸出檔案都會自動從 PDF.co 暫存檔案儲存中刪除。 連結到期的最長持續時間會根據您目前的訂閱方案而有所不同。 |
|
|
Profiles
|
profiles | string |
此參數可用來設定其他組態以進行微調,並啟用更多選項。 請造訪 PDF.co 知識庫 (https://developer.pdf.co/api/profiles/index.html) 以取得設定檔範例等。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
身體
|
body | object |
body |
|
URL
|
url | string |
url |
|
工作識別碼
|
jobId | string |
jobId |
|
頁數
|
pageCount | integer |
頁數 |
|
錯誤
|
error | boolean |
錯誤 |
|
地位
|
status | integer |
狀態 |
|
名稱
|
name | string |
名稱 |
|
學分
|
credits | integer |
credits |
|
剩餘學分
|
remainingCredits | integer |
剩餘學分 |
|
持續時間
|
duration | integer |
duration |
PDF 轉 PNG
PDF 到 PNG 的轉換。 高品質渲染。 也非常適合縮略圖生成和預覽。 請參閱 API 文件, https://developer.pdf.co/api/pdf-to-image/index.html#post-tag-pdf-convert-to-png 以取得完整的指導方針。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
URL
|
url | True | string |
來源檔案的URL。 支援來自 Google Drive、Dropbox 和 PDF.co 內建檔案儲存的連結。 |
|
內嵌
|
inline | boolean |
內嵌 |
|
|
頁面
|
pages | string |
要處理的頁面索引(或範圍)的逗號分隔清單。 第一頁從 0(零)開始。 若要設定範圍,請使用破折號 -,例如:0,2-5,7-。 要設置從索引到最後一頁的範圍,請使用如下範圍:2-(從第 #3 頁開始,因為索引從零開始,直到文檔的 )。 對於所有頁面,只需將此參數留空即可。 範例: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
|
expiration | integer |
將輸出連結的到期時間設定為分鐘(預設為 60 或 60 分鐘或 1 小時),在此指定的持續時間之後,任何產生的輸出檔案都會自動從 PDF.co 暫存檔案儲存中刪除。 連結到期的最長持續時間會根據您目前的訂閱方案而有所不同。 |
|
|
非同步
|
async | boolean |
如果長程序在背景執行,API 會設定為 true,然後會傳回 jobId,您可以搭配 JobCheck 端點使用,以檢查程序的狀態並擷取輸出,同時您可以繼續執行其他工作,而不需要等待此程序完成。 |
|
|
Profiles
|
profiles | string |
您可以使用此參數設定其他和額外的選項,以設定自訂設定。 探索 PDF.co 知識庫 (https://developer.pdf.co/api/profiles/index.html) 以取得設定檔範例。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
網址
|
urls | array of string |
網址 |
|
工作識別碼
|
jobId | string |
jobId |
|
頁數
|
pageCount | integer |
頁數 |
|
錯誤
|
error | boolean |
錯誤 |
|
地位
|
status | integer |
狀態 |
|
名稱
|
name | string |
名稱 |
|
學分
|
credits | integer |
credits |
|
剩餘積分
|
remainingCredits | integer |
剩餘學分 |
|
持續時間
|
duration | integer |
duration |
PDF 轉 TIFF
PDF 到高質量 TIFF 圖像的轉換。 高品質渲染。 也非常適合縮略圖生成和預覽。 請參閱 API 文件, https://developer.pdf.co/api/pdf-to-image/index.html#post-tag-pdf-convert-to-tiff 以取得完整的指導方針。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
URL
|
url | True | string |
來源檔案的URL。 支援來自 Google Drive、Dropbox 和 PDF.co 內建檔案儲存的連結。 |
|
內嵌
|
inline | boolean |
內嵌 |
|
|
頁面
|
pages | string |
要處理的頁面索引(或範圍)的逗號分隔清單。 第一頁從 0(零)開始。 若要設定範圍,請使用破折號 -,例如:0,2-5,7-。 要設置從索引到最後一頁的範圍,請使用如下範圍:2-(從第 #3 頁開始,因為索引從零開始,直到文檔的 )。 對於所有頁面,只需將此參數留空即可。 範例: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
|
expiration | integer |
將輸出連結的到期時間設定為分鐘(預設為 60 或 60 分鐘或 1 小時),在此指定的持續時間之後,任何產生的輸出檔案都會自動從 PDF.co 暫存檔案儲存中刪除。 連結到期的最長持續時間會根據您目前的訂閱方案而有所不同。 |
|
|
非同步
|
async | boolean |
如果長程序在背景執行,API 會設定為 true,然後會傳回 jobId,您可以搭配 JobCheck 端點使用,以檢查程序的狀態並擷取輸出,同時您可以繼續執行其他工作,而不需要等待此程序完成。 |
|
|
Profiles
|
profiles | string |
您可以使用此參數設定其他和額外的選項,以設定自訂設定。 探索 PDF.co 知識庫 (https://developer.pdf.co/api/profiles/index.html) 以取得設定檔範例。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
URL
|
url | string | |
|
工作識別碼
|
jobId | string |
jobId |
|
頁數
|
pageCount | integer |
頁數 |
|
錯誤
|
error | boolean |
錯誤 |
|
地位
|
status | integer |
狀態 |
|
名稱
|
name | string |
名稱 |
|
學分
|
credits | integer |
credits |
|
剩餘積分
|
remainingCredits | integer |
剩餘學分 |
|
持續時間
|
duration | integer |
duration |
PDF 轉 WEBP
PDF 到 WEBP 的轉換。 高品質渲染。 也非常適合縮略圖生成和預覽。 請參閱 API 文件, https://developer.pdf.co/api/pdf-to-image/index.html#post-tag-pdf-convert-to-webp 以取得完整的指導方針。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
URL
|
url | True | string |
來源檔案的URL。 支援來自 Google Drive、Dropbox 和 PDF.co 內建檔案儲存的連結。 |
|
內嵌
|
inline | boolean |
內嵌 |
|
|
頁面
|
pages | string |
要處理的頁面索引(或範圍)的逗號分隔清單。 第一頁從 0(零)開始。 若要設定範圍,請使用破折號 -,例如:0,2-5,7-。 要設置從索引到最後一頁的範圍,請使用如下範圍:2-(從第 #3 頁開始,因為索引從零開始,直到文檔的 )。 對於所有頁面,只需將此參數留空即可。 範例: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
|
expiration | integer |
將輸出連結的到期時間設定為分鐘(預設為 60 或 60 分鐘或 1 小時),在此指定的持續時間之後,任何產生的輸出檔案都會自動從 PDF.co 暫存檔案儲存中刪除。 連結到期的最長持續時間會根據您目前的訂閱方案而有所不同。 |
|
|
非同步
|
async | boolean |
如果長程序在背景執行,API 會設定為 true,然後會傳回 jobId,您可以搭配 JobCheck 端點使用,以檢查程序的狀態並擷取輸出,同時您可以繼續執行其他工作,而不需要等待此程序完成。 |
|
|
Profiles
|
profiles | string |
您可以使用此參數設定其他和額外的選項,以設定自訂設定。 探索 PDF.co 知識庫 (https://developer.pdf.co/api/profiles/index.html) 以取得設定檔範例。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
網址
|
urls | array of string |
網址 |
|
工作識別碼
|
jobId | string |
jobId |
|
頁數
|
pageCount | integer |
頁數 |
|
錯誤
|
error | boolean |
錯誤 |
|
地位
|
status | integer |
狀態 |
|
名稱
|
name | string |
名稱 |
|
學分
|
credits | integer |
credits |
|
剩餘積分
|
remainingCredits | integer |
剩餘學分 |
|
持續時間
|
duration | integer |
duration |
PDF 轉 XLS
將 PDF 和掃描圖像轉換為電子表格,並保留佈局和字體。 請參閱 API 文件, https://developer.pdf.co/api/pdf-to-excel/index.html#post-tag-pdf-convert-to-xls 以取得完整的指導方針。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
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(任意組合)。 |
|
|
打開
|
unwrap | string |
啟用 lineGrouping 時,將線條展開為表格儲存格內的單一線。 |
|
|
頁面
|
pages | string |
要處理的頁面索引(或範圍)的逗號分隔清單。 第一頁從 0(零)開始。 若要設定範圍,請使用破折號 -,例如:0,2-5,7-。 要設置從索引到最後一頁的範圍,請使用如下範圍:2-(從第 #3 頁開始,因為索引從零開始,直到文檔的 )。 對於所有頁面,只需將此參數留空即可。 範例: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 會設定為 true,然後會傳回 jobId,您可以搭配 JobCheck 端點使用,以檢查程序的狀態並擷取輸出,同時您可以繼續執行其他工作,而不需要等待此程序完成。 |
|
|
名稱
|
name | string |
產生輸出的檔案名稱 |
|
|
線分組
|
lineGrouping | string |
表格儲存格內的行分組。 設定為 1 以啟用分組。 |
|
|
Expiration
|
expiration | integer |
將輸出連結的到期時間設定為分鐘(預設為 60 或 60 分鐘或 1 小時),在此指定的持續時間之後,任何產生的輸出檔案都會自動從 PDF.co 暫存檔案儲存中刪除。 連結到期的最長持續時間會根據您目前的訂閱方案而有所不同。 |
|
|
Profiles
|
profiles | string |
此參數可用來設定其他組態以進行微調,並啟用更多選項。 請造訪 PDF.co 知識庫 (https://developer.pdf.co/api/profiles/index.html) 以取得設定檔範例等。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
URL
|
url | string |
url |
|
工作識別碼
|
jobId | string |
jobId |
|
頁數
|
pageCount | integer |
頁數 |
|
錯誤
|
error | boolean |
錯誤 |
|
地位
|
status | integer |
狀態 |
|
名稱
|
name | string |
名稱 |
|
學分
|
credits | integer |
credits |
|
剩餘學分
|
remainingCredits | integer |
剩餘學分 |
|
持續時間
|
duration | integer |
duration |
PDF 轉 XLSX
將 PDF 和掃描圖像轉換為電子表格,並保留佈局和字體。 請參閱 API 文件, https://developer.pdf.co/api/pdf-to-excel/index.html#post-tag-pdf-convert-to-xlsx 以取得完整的指導方針。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
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(任意組合)。 |
|
|
打開
|
unwrap | string |
啟用 lineGrouping 時,將線條展開為表格儲存格內的單一線。 |
|
|
頁面
|
pages | string |
要處理的頁面索引(或範圍)的逗號分隔清單。 第一頁從 0(零)開始。 若要設定範圍,請使用破折號 -,例如:0,2-5,7-。 要設置從索引到最後一頁的範圍,請使用如下範圍:2-(從第 #3 頁開始,因為索引從零開始,直到文檔的 )。 對於所有頁面,只需將此參數留空即可。 範例: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 會設定為 true,然後會傳回 jobId,您可以搭配 JobCheck 端點使用,以檢查程序的狀態並擷取輸出,同時您可以繼續執行其他工作,而不需要等待此程序完成。 |
|
|
名稱
|
name | string |
產生輸出的檔案名稱 |
|
|
線分組
|
lineGrouping | string |
表格儲存格內的行分組。 設定為 1 以啟用分組。 |
|
|
Expiration
|
expiration | integer |
將輸出連結的到期時間設定為分鐘(預設為 60 或 60 分鐘或 1 小時),在此指定的持續時間之後,任何產生的輸出檔案都會自動從 PDF.co 暫存檔案儲存中刪除。 連結到期的最長持續時間會根據您目前的訂閱方案而有所不同。 |
|
|
Profiles
|
profiles | string |
此參數可用來設定其他組態以進行微調,並啟用更多選項。 請造訪 PDF.co 知識庫 (https://developer.pdf.co/api/profiles/index.html) 以取得設定檔範例等。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
URL
|
url | string |
url |
|
工作識別碼
|
jobId | string |
jobId |
|
頁數
|
pageCount | integer |
頁數 |
|
錯誤
|
error | boolean |
錯誤 |
|
地位
|
status | integer |
狀態 |
|
名稱
|
name | string |
名稱 |
|
學分
|
credits | integer |
credits |
|
剩餘學分
|
remainingCredits | integer |
剩餘學分 |
|
持續時間
|
duration | integer |
duration |
PDF 轉 XML
將 PDF 轉換為 XML,其中包含有關文本值、表格、字體、圖像、對象位置的信息。 請參閱 API 文件, https://developer.pdf.co/api/pdf-to-xml/index.html 以取得完整的指導方針。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
URL
|
url | True | string |
來源檔案的URL。 支援來自 Google Drive、Dropbox 和 PDF.co 內建檔案儲存的連結。 |
|
內嵌
|
inline | boolean | ||
|
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(任意組合)。 |
|
|
打開
|
unwrap | string |
啟用 lineGrouping 時,將線條展開為表格儲存格內的單一線。 |
|
|
頁面
|
pages | string |
要處理的頁面索引(或範圍)的逗號分隔清單。 第一頁從 0(零)開始。 若要設定範圍,請使用破折號 -,例如:0,2-5,7-。 要設置從索引到最後一頁的範圍,請使用如下範圍:2-(從第 #3 頁開始,因為索引從零開始,直到文檔的 )。 對於所有頁面,只需將此參數留空即可。 範例: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 會設定為 true,然後會傳回 jobId,您可以搭配 JobCheck 端點使用,以檢查程序的狀態並擷取輸出,同時您可以繼續執行其他工作,而不需要等待此程序完成。 |
|
|
名稱
|
name | string |
產生輸出的檔案名稱 |
|
|
線分組
|
lineGrouping | string |
表格儲存格內的行分組。 設定為 1 以啟用分組。 |
|
|
Expiration
|
expiration | integer |
將輸出連結的到期時間設定為分鐘(預設為 60 或 60 分鐘或 1 小時),在此指定的持續時間之後,任何產生的輸出檔案都會自動從 PDF.co 暫存檔案儲存中刪除。 連結到期的最長持續時間會根據您目前的訂閱方案而有所不同。 |
|
|
Profiles
|
profiles | string |
此參數可用來設定其他組態以進行微調,並啟用更多選項。 請造訪 PDF.co 知識庫 (https://developer.pdf.co/api/profiles/index.html) 以取得設定檔範例等。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
URL
|
url | string |
url |
|
身體
|
body | string |
body |
|
工作識別碼
|
jobId | string |
jobId |
|
頁數
|
pageCount | integer |
頁數 |
|
錯誤
|
error | boolean |
錯誤 |
|
地位
|
status | integer |
狀態 |
|
名稱
|
name | string |
名稱 |
|
學分
|
credits | integer |
credits |
|
剩餘學分
|
remainingCredits | integer |
剩餘學分 |
|
持續時間
|
duration | integer |
duration |
PDF 轉掃描的 PDF
將 PDF 轉換為掃描的 PDF。 結果 PDF 與您列印然後掃描 PDF 相同。 請參閱 API 文件, https://developer.pdf.co/api/pdf-make-text-searchable-or-unsearchable/index.html#post-tag-pdf-makeunsearchable 以取得完整的指導方針。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
URL
|
url | True | string |
來源檔案的URL。 支援來自 Google Drive、Dropbox 和 PDF.co 內建檔案儲存的連結。 |
|
頁面
|
pages | string |
要處理的頁面索引(或範圍)的逗號分隔清單。 第一頁從 0(零)開始。 若要設定範圍,請使用破折號 -,例如:0,2-5,7-。 要設置從索引到最後一頁的範圍,請使用如下範圍:2-(從第 #3 頁開始,因為索引從零開始,直到文檔的 )。 對於所有頁面,只需將此參數留空即可。 範例: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) 以取得設定檔範例。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
URL
|
url | string |
url |
|
工作識別碼
|
jobId | string |
jobId |
|
頁數
|
pageCount | integer |
頁數 |
|
錯誤
|
error | boolean |
錯誤 |
|
地位
|
status | integer |
狀態 |
|
學分
|
credits | integer |
credits |
|
剩餘積分
|
remainingCredits | integer |
剩餘學分 |
|
持續時間
|
duration | integer |
duration |
PDF 轉文本(帶有佈局和 ocr)
將 PDF 和掃描影像轉換為保留版面配置的文字。 請參閱 API 文件, https://developer.pdf.co/api/pdf-to-text/index.html 以取得完整的指導方針。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
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(任意組合)。 |
|
|
內嵌
|
inline | boolean | ||
|
打開
|
unwrap | string |
啟用 lineGrouping 時,將線條展開為表格儲存格內的單一線。 |
|
|
頁面
|
pages | string |
要處理的頁面索引(或範圍)的逗號分隔清單。 第一頁從 0(零)開始。 若要設定範圍,請使用破折號 -,例如:0,2-5,7-。 要設置從索引到最後一頁的範圍,請使用如下範圍:2-(從第 #3 頁開始,因為索引從零開始,直到文檔的 )。 對於所有頁面,只需將此參數留空即可。 範例: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 會設定為 true,然後會傳回 jobId,您可以搭配 JobCheck 端點使用,以檢查程序的狀態並擷取輸出,同時您可以繼續執行其他工作,而不需要等待此程序完成。 |
|
|
名稱
|
name | string |
產生輸出的檔案名稱 |
|
|
線分組
|
lineGrouping | string |
表格儲存格內的行分組。 設定為 1 以啟用分組。 |
|
|
Expiration
|
expiration | integer |
將輸出連結的到期時間設定為分鐘(預設為 60 或 60 分鐘或 1 小時),在此指定的持續時間之後,任何產生的輸出檔案都會自動從 PDF.co 暫存檔案儲存中刪除。 連結到期的最長持續時間會根據您目前的訂閱方案而有所不同。 |
|
|
Profiles
|
profiles | string |
此參數可用來設定其他組態以進行微調,並啟用更多選項。 請造訪 PDF.co 知識庫 (https://developer.pdf.co/api/profiles/index.html) 以取得設定檔範例等。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
身體
|
body | string |
body |
|
URL
|
url | string |
url |
|
工作識別碼
|
jobId | string |
jobId |
|
頁數
|
pageCount | integer |
頁數 |
|
錯誤
|
error | boolean |
錯誤 |
|
地位
|
status | integer |
狀態 |
|
名稱
|
name | string |
名稱 |
|
學分
|
credits | integer |
credits |
|
剩餘學分
|
remainingCredits | integer |
剩餘學分 |
|
持續時間
|
duration | integer |
duration |
PDF 轉文本(無佈局和 ocr)
將 PDF 轉換為純文本,無需保留佈局和 OCR 支持。 請參閱 API 文件, https://developer.pdf.co/api/pdf-to-text/index.html#post-tag-pdf-convert-to-text-simple 以取得完整的指導方針。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
URL
|
url | True | string |
來源檔案的URL。 支援來自 Google Drive、Dropbox 和 PDF.co 內建檔案儲存的連結。 |
|
內嵌
|
inline | boolean | ||
|
頁面
|
pages | string |
要處理的頁面索引(或範圍)的逗號分隔清單。 第一頁從 0(零)開始。 若要設定範圍,請使用破折號 -,例如:0,2-5,7-。 要設置從索引到最後一頁的範圍,請使用如下範圍:2-(從第 #3 頁開始,因為索引從零開始,直到文檔的 )。 對於所有頁面,只需將此參數留空即可。 範例:0,2-5,7- 表示第一頁,然後是第 3 頁到第 6 頁,然後是從第 8 頁(索引 = 7)到文件結尾的範圍。 |
|
|
非同步
|
async | boolean |
如果長程序在背景執行,API 會設定為 true,然後會傳回 jobId,您可以搭配 JobCheck 端點使用,以檢查程序的狀態並擷取輸出,同時您可以繼續執行其他工作,而不需要等待此程序完成。 |
|
|
名稱
|
name | string |
產生輸出的檔案名稱 |
|
|
Expiration
|
expiration | integer |
將輸出連結的到期時間設定為分鐘(預設為 60 或 60 分鐘或 1 小時),在此指定的持續時間之後,任何產生的輸出檔案都會自動從 PDF.co 暫存檔案儲存中刪除。 連結到期的最長持續時間會根據您目前的訂閱方案而有所不同。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
身體
|
body | string |
body |
|
URL
|
url | string |
url |
|
工作識別碼
|
jobId | string |
jobId |
|
頁數
|
pageCount | integer |
頁數 |
|
錯誤
|
error | boolean |
錯誤 |
|
地位
|
status | integer |
狀態 |
|
名稱
|
name | string |
名稱 |
|
學分
|
credits | integer |
credits |
|
剩餘學分
|
remainingCredits | integer |
剩餘學分 |
|
持續時間
|
duration | integer |
duration |
PDF 附件提取
從輸入的 PDF 文檔中提取附件。 請參閱 API 文件, https://developer.pdf.co/api/extract-attachments/index.html 以取得完整的指導方針。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
URL
|
url | True | string |
來源 PDF 文件的 URL |
|
內嵌
|
inline | boolean |
決定是否要傳回輸出作為回應或連結至輸出檔案。 |
|
|
名稱
|
name | string |
新 PDF 檔案的基底檔案名稱 |
|
|
Expiration
|
expiration | integer |
將輸出連結的到期時間設定為分鐘(預設為 60 或 60 分鐘或 1 小時),在此指定的持續時間之後,任何產生的輸出檔案都會自動從 PDF.co 暫存檔案儲存中刪除。 連結到期的最長持續時間會根據您目前的訂閱方案而有所不同。 |
|
|
Profiles
|
profiles | string |
使用此參數可設定微調和額外選項的其他配置。 探索 PDF.co 知識庫 (https://developer.pdf.co/api/profiles/index.html) 以取得設定檔範例。 |
|
|
非同步
|
async | boolean |
建立背景處理工作。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
網址
|
urls | array of string |
網址 |
|
URL
|
url | string |
輸出文件 URL。 |
|
工作識別碼
|
jobId | string |
jobId |
|
Count
|
pageCount | integer |
輸出文件中的頁數。 |
|
錯誤
|
error | boolean |
指出作業是否成功。 |
|
地位
|
status | integer |
HTTP 回應的狀態碼 |
|
名稱
|
name | string |
輸出文件名稱 |
|
學分
|
credits | integer |
PDF.co 用於此請求的積分 |
|
持續時間
|
duration | integer |
請求執行持續時間 |
|
剩餘積分
|
remainingCredits | integer |
PDF.co 帳戶剩餘點數 |
URL 轉為 PDF
從 URL 建立 PDF。 請參閱 API 文件, https://developer.pdf.co/api/pdf-from-url/index.html 以取得完整的指導方針。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
URL
|
url | True | string |
要轉換的輸入 HTML 文件或網站頁面的鏈接。 您可以從 Google Drive、Dropbox 或其他可以生成可共享鏈接的在線文件服務傳遞文件鏈接。 |
|
邊距
|
margins | string |
輸出文件中使用的邊距。 設定為 css 樣式邊距,例如 10px、5mm、5in (所有邊距) 或 5px 5px 5px 5px (邊距的順序為上、右、下、左)。 |
|
|
紙張尺寸
|
paperSize | string |
預設會設定 Letter。 可以是 Letter、Legal、Tabloid、Ledger、A0、A1、A2、A3、A4、A5、A6 或自定義尺寸。 自定義尺寸可以以像素(像素)、毫米或(英寸)為單位設置,寬度和高度由空間分隔,如下所示:200 300、200 像素、300 像素、200 毫米、300 厘米、20 厘米 30 厘米或 6 英寸 8 英寸。 |
|
|
導覽
|
orientation | string |
輸出頁面方向 |
|
|
列印背景
|
printBackground | boolean |
啟用或停用列印文件背景 |
|
|
Header
|
header | html |
設定為 HTML,以便將標頭套用至頁首處的每個頁面。 |
|
|
頁尾
|
footer | html |
設定為 HTML 以將頁尾套用至底部的每個頁面。 |
|
|
Expiration
|
expiration | integer |
將輸出連結的到期時間設定為分鐘(預設為 60 或 60 分鐘或 1 小時),在此指定的持續時間之後,任何產生的輸出檔案都會自動從 PDF.co 暫存檔案儲存中刪除。 連結到期的最長持續時間會根據您目前的訂閱方案而有所不同。 |
|
|
Profiles
|
profiles | string |
此參數可用來設定其他組態以進行微調,並啟用更多選項。 請造訪 PDF.co 知識庫 (https://developer.pdf.co/api/profiles/index.html) 以取得設定檔範例等。 |
|
|
非同步
|
async | boolean |
如果長程序在背景執行,API 會設定為 true,然後會傳回 jobId,您可以搭配 JobCheck 端點使用,以檢查程序的狀態並擷取輸出,同時您可以繼續執行其他工作,而不需要等待此程序完成。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
URL
|
url | string |
輸出文件 URL。 |
|
工作識別碼
|
jobId | string |
jobId |
|
頁數
|
pageCount | integer |
輸出文件中的頁數。 |
|
錯誤
|
error | boolean |
指出作業是否成功。 |
|
狀態代碼
|
status | integer |
HTTP 回應的狀態碼 |
|
名稱
|
name | string |
輸出文件名稱 |
|
學分
|
credits | integer |
PDF.co 用於此請求的積分 |
|
持續時間
|
duration | integer |
請求執行持續時間 |
|
剩餘積分
|
remainingCredits | integer |
PDF.co 帳戶剩餘點數 |
使掃描的 PDF 轉換為文本可搜索
將 PDF 和掃描的 JPG、PNG 圖像轉換為可文本搜索的 PDF。 請參閱 API 文件, https://developer.pdf.co/api/pdf-make-text-searchable-or-unsearchable/index.html#post-tag-pdf-makesearchable 以取得完整的指導方針。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
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 頁開始,因為索引從零開始,直到文檔的 )。 對於所有頁面,只需將此參數留空即可。 範例: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) 以取得設定檔範例。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
URL
|
url | string |
url |
|
工作識別碼
|
jobId | string |
jobId |
|
頁數
|
pageCount | integer |
頁數 |
|
錯誤
|
error | boolean |
錯誤 |
|
地位
|
status | integer |
狀態 |
|
學分
|
credits | integer |
credits |
|
剩餘積分
|
remainingCredits | integer |
剩餘學分 |
|
持續時間
|
duration | integer |
duration |
來自圖像的 PDF
從一個或多個 JPG、PNG、TIFF 圖像創建 PDF 文件。 請參閱 API 文件, https://developer.pdf.co/api/pdf-from-image/index.html 以取得完整的指導方針。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
URL
|
url | True | string |
來源檔案的URL。 以逗號分隔格式提供多個 URL。 支援來自 Google Drive、Dropbox 和 PDF.co 內建檔案儲存的連結。 |
|
名稱
|
name | string |
產生輸出的檔案名稱。 |
|
|
Expiration
|
expiration | integer |
將輸出連結的到期時間設定為分鐘(預設為 60 或 60 分鐘或 1 小時),在此指定的持續時間之後,任何產生的輸出檔案都會自動從 PDF.co 暫存檔案儲存中刪除。 連結到期的最長持續時間會根據您目前的訂閱方案而有所不同。 |
|
|
非同步
|
async | boolean |
如果長程序在背景執行,API 會設定為 true,然後會傳回 jobId,您可以搭配 JobCheck 端點使用,以檢查程序的狀態並擷取輸出,同時您可以繼續執行其他工作,而不需要等待此程序完成。 |
|
|
Profiles
|
profiles | string |
您可以使用此參數設定其他和額外的選項,以設定自訂設定。 探索 PDF.co 知識庫 (https://developer.pdf.co/api/profiles/index.html) 以取得設定檔範例。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
URL
|
url | string | |
|
工作識別碼
|
jobId | string |
jobId |
|
頁數
|
pageCount | integer |
頁數 |
|
錯誤
|
error | boolean |
錯誤 |
|
地位
|
status | integer |
狀態 |
|
名稱
|
name | string |
名稱 |
|
學分
|
credits | integer |
credits |
|
剩餘積分
|
remainingCredits | integer |
剩餘學分 |
|
持續時間
|
duration | integer |
duration |
來自電子郵件的 PDF
將電子郵件文件(MSG 或 EML)代碼轉換為 PDF。 從輸入電子郵件中提取附件(如果有),並作為 pdf 附件嵌入到 PDF 中。 請參閱 API 文件, https://developer.pdf.co/api/pdf-from-email/index.html 以取得完整的指導方針。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
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、5in (所有邊距) 或 5px 5px 5px 5px (邊距的順序為上、右、下、左)。 |
|
|
紙張尺寸
|
paperSize | string |
預設會設定 Letter。 可以是 Letter、Legal、Tabloid、Ledger、A0、A1、A2、A3、A4、A5、A6 或自定義尺寸。 自定義尺寸可以以像素(像素)、毫米或(英寸)為單位設置,寬度和高度由空間分隔,如下所示:200 300、200 像素、300 像素、200 毫米、300 厘米、20 厘米 30 厘米或 6 英寸 8 英寸。 |
|
|
導覽
|
orientation | string | ||
|
名稱
|
name | string |
產生輸出的檔案名稱。 |
|
|
Expiration
|
expiration | integer |
將輸出連結的到期時間設定為分鐘(預設為 60 或 60 分鐘或 1 小時),在此指定的持續時間之後,任何產生的輸出檔案都會自動從 PDF.co 暫存檔案儲存中刪除。 連結到期的最長持續時間會根據您目前的訂閱方案而有所不同。 |
|
|
非同步
|
async | boolean |
如果長程序在背景執行,API 會設定為 true,然後會傳回 jobId,您可以搭配 JobCheck 端點使用,以檢查程序的狀態並擷取輸出,同時您可以繼續執行其他工作,而不需要等待此程序完成。 |
|
|
Profiles
|
profiles | string |
您可以使用此參數設定其他和額外的選項,以設定自訂設定。 探索 PDF.co 知識庫 (https://developer.pdf.co/api/profiles/index.html) 以取得設定檔範例。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
URL
|
url | string | |
|
工作識別碼
|
jobId | string |
jobId |
|
頁數
|
pageCount | integer |
頁數 |
|
錯誤
|
error | boolean |
錯誤 |
|
地位
|
status | integer |
狀態 |
|
名稱
|
name | string |
名稱 |
|
學分
|
credits | integer |
credits |
|
剩餘積分
|
remainingCredits | integer |
剩餘學分 |
|
持續時間
|
duration | integer |
duration |
分割 PDF
使用頁碼和頁碼範圍將 PDF 文件中的頁面分割成多個新的 PDF 檔案。 請參閱 API 文件, https://developer.pdf.co/api/pdf-split/index.html 以取得完整的指導方針。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
URL
|
url | True | string |
來源 PDF 文件的 URL |
|
頁面
|
pages | True | string |
要分割成的頁面索引(或範圍)的逗號分隔清單。 第一頁是 1(一)。 範例:「1,2-5,7-」。 特殊情況:若要將每個頁面擷取為個別的 PDF,請使用 |
|
內嵌
|
inline | boolean |
決定是否要傳回輸出作為回應或連結至輸出檔案。 |
|
|
名稱
|
name | string |
新 PDF 檔案的基底檔案名稱 |
|
|
Expiration
|
expiration | integer |
將輸出連結的到期時間設定為分鐘(預設為 60 或 60 分鐘或 1 小時),在此指定的持續時間之後,任何產生的輸出檔案都會自動從 PDF.co 暫存檔案儲存中刪除。 連結到期的最長持續時間會根據您目前的訂閱方案而有所不同。 |
|
|
Profiles
|
profiles | string |
使用此參數可設定微調和額外選項的其他配置。 探索 PDF.co 知識庫 (https://developer.pdf.co/api/profiles/index.html) 以取得設定檔範例。 |
|
|
非同步
|
async | boolean |
建立背景處理工作。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
網址
|
urls | array of string |
網址 |
|
URL
|
url | string |
輸出文件 URL。 |
|
工作識別碼
|
jobId | string |
jobId |
|
頁數
|
pageCount | integer |
輸出文件中的頁數。 |
|
錯誤
|
error | boolean |
指出作業是否成功。 |
|
地位
|
status | integer |
HTTP 回應的狀態碼 |
|
名稱
|
name | string |
輸出文件名稱 |
|
學分
|
credits | integer |
PDF.co 用於此請求的積分 |
|
持續時間
|
duration | integer |
請求執行持續時間 |
|
剩餘積分
|
remainingCredits | integer |
PDF.co 帳戶剩餘點數 |
分割 PDF (進階)
通過文本搜索(支持正則表達式)或條形碼將PDF拆分為多個PDF文件。 請參閱 API 文件, https://developer.pdf.co/api/pdf-split/index.html#post-tag-pdf-split2 以取得完整的指導方針。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
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 | 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 | string |
新 PDF 檔案的基底檔案名稱 |
|
|
Expiration
|
expiration | integer |
將輸出連結的到期時間設定為分鐘(預設為 60 或 60 分鐘或 1 小時),在此指定的持續時間之後,任何產生的輸出檔案都會自動從 PDF.co 暫存檔案儲存中刪除。 連結到期的最長持續時間會根據您目前的訂閱方案而有所不同。 |
|
|
Profiles
|
profiles | string |
使用此參數可設定微調和額外選項的其他配置。 探索 PDF.co 知識庫 (https://developer.pdf.co/api/profiles/index.html) 以取得設定檔範例。 |
|
|
非同步
|
async | boolean |
建立背景處理工作。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
網址
|
urls | array of string |
網址 |
|
URL
|
url | string |
輸出文件 URL。 |
|
工作識別碼
|
jobId | string |
jobId |
|
頁數
|
pageCount | integer |
輸出文件中的頁數。 |
|
錯誤
|
error | boolean |
指出作業是否成功。 |
|
地位
|
status | integer |
HTTP 回應的狀態碼 |
|
名稱
|
name | string |
輸出文件名稱 |
|
學分
|
credits | integer |
PDF.co 用於此請求的積分 |
|
持續時間
|
duration | integer |
請求執行持續時間 |
|
剩餘積分
|
remainingCredits | integer |
PDF.co 帳戶剩餘點數 |
合併 PDF
將兩個或多個 PDF 文件中的 PDF 合併到一個新文件中。 請參閱 API 文件, https://developer.pdf.co/api/pdf-merge/index.html 以取得完整的指導方針。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
URL
|
url | True | string |
以逗號分隔的 PDF 檔案連結清單。 支援外部網站的連結, |
|
Expiration
|
expiration | integer |
將輸出連結的到期時間設定為分鐘(預設為 60 或 60 分鐘或 1 小時),在此指定的持續時間之後,任何產生的輸出檔案都會自動從 PDF.co 暫存檔案儲存中刪除。 連結到期的最長持續時間會根據您目前的訂閱方案而有所不同。 |
|
|
Profiles
|
profiles | string |
使用此參數可設定微調和額外選項的其他配置。 探索 PDF.co 知識庫 (https://developer.pdf.co/api/profiles/index.html) 以取得設定檔範例。 |
|
|
非同步
|
async | boolean |
將 async 設定為 true 以在背景執行長進程,API 接著會傳回 jobId,您可以搭配 JobCheck 端點使用,以檢查進程的狀態並擷取輸出,同時您可以繼續執行其他工作,而不需要等待此進程完成。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
URL
|
url | string |
輸出文件 URL。 |
|
工作識別碼
|
jobId | string |
jobId |
|
頁數
|
pageCount | integer |
輸出文件中的頁數。 |
|
錯誤
|
error | boolean |
指出作業是否成功。 |
|
狀態代碼
|
status | integer |
HTTP 回應的狀態碼 |
|
名稱
|
name | string |
輸出文件名稱 |
|
學分
|
credits | integer |
PDF.co 用於此請求的積分 |
|
持續時間
|
duration | integer |
請求執行持續時間 |
|
剩餘積分
|
remainingCredits | integer |
PDF.co 帳戶剩餘點數 |
合併 PDF (進階)
將兩個或多個 pdf、doc、xls、圖像中的 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 以取得完整的指導方針。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
URL
|
url | True | string |
以逗號分隔的 PDF、文件、試算表、影像連結清單。 支援外部網站的連結, |
|
Expiration
|
expiration | integer |
將輸出連結的到期時間設定為分鐘(預設為 60 或 60 分鐘或 1 小時),在此指定的持續時間之後,任何產生的輸出檔案都會自動從 PDF.co 暫存檔案儲存中刪除。 連結到期的最長持續時間會根據您目前的訂閱方案而有所不同。 |
|
|
Profiles
|
profiles | string |
使用此參數可設定微調和額外選項的其他配置。 探索 PDF.co 知識庫 (https://developer.pdf.co/api/profiles/index.html) 以取得設定檔範例。 |
|
|
非同步
|
async | boolean |
將 async 設定為 true 以在背景執行長進程,API 接著會傳回 jobId,您可以搭配 JobCheck 端點使用,以檢查進程的狀態並擷取輸出,同時您可以繼續執行其他工作,而不需要等待此進程完成。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
URL
|
url | string |
輸出文件 URL。 |
|
工作識別碼
|
jobId | string |
jobId |
|
頁數
|
pageCount | integer |
輸出文件中的頁數。 |
|
錯誤
|
error | boolean |
指出作業是否成功。 |
|
狀態代碼
|
status | integer |
HTTP 回應的狀態碼 |
|
名稱
|
name | string |
輸出文件名稱 |
|
學分
|
credits | integer |
PDF.co 用於此請求的積分 |
|
持續時間
|
duration | integer |
請求執行持續時間 |
|
剩餘積分
|
remainingCredits | integer |
PDF.co 帳戶剩餘點數 |
將文本、圖像、表單字段添加到 PDF
將文本、圖像、簽名添加到 pdf。 填寫 PDF 表單字段並從模板創建新的 pdf。 請參閱 API 文件, https://developer.pdf.co/api/pdf-add/index.html 以取得完整的指導方針。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
URL
|
url | True | string |
輸入 PDF 文件的 URL |
|
註釋字串
|
annotationsString | string |
要新增至 PDF 文件的註解字串。 格式應該像「x;y;頁;文本“。 請參閱 PDF.co 文件以取得更進階的格式和範例。 |
|
|
圖片 String
|
imagesString | string |
要新增至 PDF 文件的影像。 格式應該像「x;y;頁;網址圖片;連接;寬度;高度“。 請參閱 PDF.co 文件以取得更進階的格式和範例。 |
|
|
欄位字串
|
fieldsString | string |
填寫 PDF 表單欄位。 格式應該像「頁面;欄位名稱;價值“。 請參閱 PDF.co 文件以取得更進階的格式和範例。 |
|
|
名稱
|
name | string |
輸出 PDF 名稱 |
|
|
內嵌
|
inline | boolean |
決定是否要傳回輸出作為回應或連結至輸出檔案。 |
|
|
Expiration
|
expiration | integer |
將輸出連結的到期時間設定為分鐘(預設為 60 或 60 分鐘或 1 小時),在此指定的持續時間之後,任何產生的輸出檔案都會自動從 PDF.co 暫存檔案儲存中刪除。 連結到期的最長持續時間會根據您目前的訂閱方案而有所不同。 |
|
|
Profiles
|
profiles | string |
此參數可用來設定其他組態以進行微調,並啟用更多選項。 請造訪 PDF.co 知識庫 (https://developer.pdf.co/api/profiles/index.html) 以取得設定檔範例等。 |
|
|
非同步
|
async | boolean |
如果長程序在背景執行,API 會設定為 true,然後會傳回 jobId,您可以搭配 JobCheck 端點使用,以檢查程序的狀態並擷取輸出,同時您可以繼續執行其他工作,而不需要等待此程序完成。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
URL
|
url | string |
輸出文件 URL。 |
|
工作識別碼
|
jobId | string |
jobId |
|
頁數
|
pageCount | integer |
輸出文件中的頁數。 |
|
錯誤
|
error | boolean |
指出作業是否成功。 |
|
狀態代碼
|
status | integer |
HTTP 回應的狀態碼 |
|
名稱
|
name | string |
輸出文件名稱 |
|
學分
|
credits | integer |
PDF.co 用於此請求的積分 |
|
持續時間
|
duration | integer |
請求執行持續時間 |
|
剩餘積分
|
remainingCredits | integer |
PDF.co 帳戶剩餘點數 |
文件分類器
根據基於關鍵字的規則對傳入文檔進行自動分類。 例如,您可以定義規則來尋找哪個廠商提供了文件,以尋找要相應地套用的範本。 請參閱 API 文件, https://developer.pdf.co/api/document-classifier/index.html 以取得完整的指導方針。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
URL
|
url | True | string |
來源檔案的URL。 支援來自 Google Drive、Dropbox 和 PDF.co 內建檔案儲存的連結。 |
|
規則 (CSV 格式)
|
rulescsv | string |
以 CSV 格式定義自訂分類規則。 規則採用 CSV 格式,其中每一列包含:「類別名稱、邏輯 (AND 或 OR (預設)) 和關鍵字」,並以逗號分隔。 每一列都由 \n 符號分隔。 |
|
|
規則網址 (CSV 格式)
|
rulescsvurl | string |
您可以使用此參數,並將 URL 設定為具有分類規則的 CSV 檔案,而不是內嵌 CSV。 如果您有單獨的開發人員處理 CSV 規則,這非常有用。 |
|
|
區分大小寫
|
caseSensitive | boolean |
定義規則中的關鍵字是否區分大小寫。 |
|
|
內嵌
|
inline | boolean |
設定為 true 以傳回回應內的結果。 否則,端點將傳回所產生輸出檔案的連結。 |
|
|
Expiration
|
expiration | integer |
將輸出連結的到期時間設定為分鐘(預設為 60 或 60 分鐘或 1 小時),在此指定的持續時間之後,任何產生的輸出檔案都會自動從 PDF.co 暫存檔案儲存中刪除。 連結到期的最長持續時間會根據您目前的訂閱方案而有所不同。 |
|
|
密碼
|
password | string |
PDF檔案的密碼 |
|
|
Profiles
|
profiles | string |
使用此參數可設定微調和額外選項的其他配置。 探索 PDF.co 知識庫 (https://developer.pdf.co/api/profiles/index.html) 以取得設定檔範例。 |
|
|
非同步
|
async | boolean |
將 async 設定為 true 以在背景執行長進程,API 接著會傳回 jobId,您可以搭配 JobCheck 端點使用,以檢查進程的狀態並擷取輸出,同時您可以繼續執行其他工作,而不需要等待此進程完成。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
URL
|
url | string |
url |
|
classes
|
body.classes | array of object | |
|
Class
|
body.classes.class | string | |
|
工作識別碼
|
jobId | string |
jobId |
|
頁數
|
pageCount | integer |
頁數 |
|
錯誤
|
error | boolean |
錯誤 |
|
地位
|
status | integer |
狀態 |
|
名稱
|
name | string |
名稱 |
|
學分
|
credits | integer |
credits |
|
剩餘積分
|
remainingCredits | integer |
剩餘學分 |
|
持續時間
|
duration | integer |
duration |
文件剖析器
文件剖析器可以自動解析 PDF、JPG 和 PNG 文件,以從發票、報表、訂單和其他 PDF 和掃描文件中提取欄位、表格、值和條碼。 請參閱 API 文件, https://developer.pdf.co/api/document-parser/index.html 以取得完整的指導方針。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
URL
|
url | True | string |
來源檔案的URL。 支援來自 Google Drive、Dropbox 和 PDF.co 內建檔案儲存的連結。 若要透過 API 上傳檔案,請查看檔案上傳區段,網址為 https://developer.pdf.co/api/file-upload/index.html |
|
範本識別碼
|
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
|
expiration | integer |
將輸出連結的到期時間設定為分鐘(預設為 60 或 60 分鐘或 1 小時),在此指定的持續時間之後,任何產生的輸出檔案都會自動從 PDF.co 暫存檔案儲存中刪除。 連結到期的最長持續時間會根據您目前的訂閱方案而有所不同。 |
|
|
非同步
|
async | boolean |
將 async 設定為 true 以在背景執行的長進程,API 隨後會傳回一個 jobId,您可以將其與「作業檢查」一起使用來檢查進程的狀態並擷取輸出,同時您可以繼續執行其他任務,而無需等待此進程完成。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
URL
|
url | string |
輸出網址 |
|
物件
|
body.objects | array of object |
tables |
|
名稱
|
body.objects.name | string |
名稱 |
|
objectType
|
body.objects.objectType | string |
物件類型 |
|
value
|
body.objects.value | string |
value |
|
頁面索引
|
body.objects.pageIndex | integer |
頁面索引 |
|
矩形
|
body.objects.rectangle | array of float |
矩形 |
|
行
|
body.objects.rows | array of object |
行 |
|
items
|
body.objects.rows | object | |
|
頁數
|
pageCount | integer | |
|
工作識別碼
|
jobId | string | |
|
地位
|
status | integer | |
|
名稱
|
name | string | |
|
剩餘積分
|
remainingCredits | integer | |
|
Message
|
message | string |
文檔中的 PDF(文檔、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 以取得完整的指導方針。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
URL
|
url | True | string |
來源檔案的URL。 支援來自 Google Drive、Dropbox 和 PDF.co 內建檔案儲存的連結。 |
|
頁面
|
pages | string |
要處理的頁面索引(或範圍)的逗號分隔清單。 第一頁從 0(零)開始。 若要設定範圍,請使用破折號 -,例如:0,2-5,7-。 要設置從索引到最後一頁的範圍,請使用如下範圍:2-(從第 #3 頁開始,因為索引從零開始,直到文檔的 )。 對於所有頁面,只需將此參數留空即可。 範例:0,2-5,7- 表示第一頁,然後是第 3 頁到第 6 頁,然後是從第 8 頁(索引 = 7)到文件結尾的範圍。 |
|
|
名稱
|
name | string |
產生輸出的檔案名稱。 |
|
|
Expiration
|
expiration | integer |
將輸出連結的到期時間設定為分鐘(預設為 60 或 60 分鐘或 1 小時),在此指定的持續時間之後,任何產生的輸出檔案都會自動從 PDF.co 暫存檔案儲存中刪除。 連結到期的最長持續時間會根據您目前的訂閱方案而有所不同。 |
|
|
非同步
|
async | boolean |
如果長程序在背景執行,API 會設定為 true,然後會傳回 jobId,您可以搭配 JobCheck 端點使用,以檢查程序的狀態並擷取輸出,同時您可以繼續執行其他工作,而不需要等待此程序完成。 |
|
|
Profiles
|
profiles | string |
您可以使用此參數設定其他和額外的選項,以設定自訂設定。 探索 PDF.co 知識庫 (https://developer.pdf.co/api/profiles/index.html) 以取得設定檔範例。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
URL
|
url | string | |
|
工作識別碼
|
jobId | string |
jobId |
|
頁數
|
pageCount | integer |
頁數 |
|
錯誤
|
error | boolean |
錯誤 |
|
地位
|
status | integer |
狀態 |
|
名稱
|
name | string |
名稱 |
|
學分
|
credits | integer |
credits |
|
剩餘積分
|
remainingCredits | integer |
剩餘學分 |
|
持續時間
|
duration | integer |
duration |
旋轉 PDF 頁面
旋轉 PDF 頁面。 請參閱 API 文件, https://developer.pdf.co/api/pdf-rotate-pages/index.html 以取得完整的指導方針。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
URL
|
url | True | string |
來源檔案的URL。 支援來自 Google Drive、Dropbox 和 PDF.co 內建檔案儲存的連結。 |
|
角度
|
angle | integer |
角度(以度為單位)。 支援的值 90、180 和 270。 |
|
|
頁面
|
pages | string |
要處理的頁面索引(或範圍)的逗號分隔清單。 第一頁從 0(零)開始。 若要設定範圍,請使用破折號 -,例如:0,2-5,7-。 要設置從索引到最後一頁的範圍,請使用如下範圍:2-(從第 #3 頁開始,因為索引從零開始,直到文檔的 )。 對於所有頁面,只需將此參數留空即可。 範例:0,2-5,7- 表示第一頁,然後是第 3 頁到第 6 頁,然後是從第 8 頁(索引 = 7)到文件結尾的範圍。 |
|
|
Expiration
|
expiration | integer |
將輸出連結的到期時間設定為分鐘(預設為 60 或 60 分鐘或 1 小時),在此指定的持續時間之後,任何產生的輸出檔案都會自動從 PDF.co 暫存檔案儲存中刪除。 連結到期的最長持續時間會根據您目前的訂閱方案而有所不同。 |
|
|
密碼
|
password | string |
PDF檔案的密碼 |
|
|
Profiles
|
profiles | string |
使用此參數可設定微調和額外選項的其他配置。 探索 PDF.co 知識庫 (https://developer.pdf.co/api/profiles/index.html) 以取得設定檔範例。 |
|
|
非同步
|
async | boolean |
將 async 設定為 true 以在背景執行長進程,API 接著會傳回 jobId,您可以搭配 JobCheck 端點使用,以檢查進程的狀態並擷取輸出,同時您可以繼續執行其他工作,而不需要等待此進程完成。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
URL
|
url | string |
url |
|
工作識別碼
|
jobId | string |
jobId |
|
頁數
|
pageCount | integer |
頁數 |
|
錯誤
|
error | boolean |
錯誤 |
|
地位
|
status | integer |
狀態 |
|
名稱
|
name | string |
名稱 |
|
學分
|
credits | integer |
credits |
|
剩餘積分
|
remainingCredits | integer |
剩餘學分 |
|
持續時間
|
duration | integer |
duration |
旋轉 PDF 頁面 (自動)
使用 AI 根據文本分析自動修復掃描 PDF 內頁面的旋轉。 請參閱 API 文件, https://developer.pdf.co/api/pdf-rotate-pages/index.html#post-tag-pdf-edit-rotate-auto 以取得完整的指導方針。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
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
|
expiration | integer |
將輸出連結的到期時間設定為分鐘(預設為 60 或 60 分鐘或 1 小時),在此指定的持續時間之後,任何產生的輸出檔案都會自動從 PDF.co 暫存檔案儲存中刪除。 連結到期的最長持續時間會根據您目前的訂閱方案而有所不同。 |
|
|
密碼
|
password | string |
PDF檔案的密碼 |
|
|
Profiles
|
profiles | string |
使用此參數可設定微調和額外選項的其他配置。 探索 PDF.co 知識庫 (https://developer.pdf.co/api/profiles/index.html) 以取得設定檔範例。 |
|
|
非同步
|
async | boolean |
將 async 設定為 true 以在背景執行長進程,API 接著會傳回 jobId,您可以搭配 JobCheck 端點使用,以檢查進程的狀態並擷取輸出,同時您可以繼續執行其他工作,而不需要等待此進程完成。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
URL
|
url | string |
url |
|
工作識別碼
|
jobId | string |
jobId |
|
頁數
|
pageCount | integer |
頁數 |
|
錯誤
|
error | boolean |
錯誤 |
|
地位
|
status | integer |
狀態 |
|
名稱
|
name | string |
名稱 |
|
學分
|
credits | integer |
credits |
|
剩餘積分
|
remainingCredits | integer |
剩餘學分 |
|
持續時間
|
duration | integer |
duration |
條碼產生器
生成高質量的條碼圖像。 支援 QR Code、Datamatrix、Code 39、Code 128、PDF417 等多種條碼類型。 請參閱 API 文件, https://developer.pdf.co/api/barcode-generator/index.html 以取得完整的指導方針。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
名稱
|
name | string |
將 async 設定為 true 以在背景執行長進程,API 接著會傳回 jobId,您可以搭配 /job/check 端點使用,以檢查進程的狀態並擷取輸出,同時您可以繼續執行其他工作,而不需要等待此進程完成。 |
|
|
價值觀
|
value | True | string |
設定字串值以在條碼內進行編碼。 |
|
類型
|
type | True | string |
設定條碼類型,預設情況下 QRCode。 |
|
裝飾圖片
|
decorationImage | string |
將此設定為您要在 QR-Code 條碼內插入徽標的影像。 |
|
|
非同步
|
async | boolean |
將 async 設定為 true 以在背景執行長進程,API 隨後將傳回一個 jobId,您可以將其與 JobCheck 模組一起使用來檢查進程的狀態並檢索輸出,同時您可以繼續執行其他任務,而無需等待此進程完成。 |
|
|
Expiration
|
expiration | integer |
將輸出連結的到期時間設定為分鐘(預設為 60 或 60 分鐘或 1 小時),在此指定的持續時間之後,任何產生的輸出檔案都會自動從 PDF.co 暫存檔案儲存中刪除。 連結到期的最長持續時間會根據您目前的訂閱方案而有所不同。 |
|
|
Profiles
|
profiles | string |
使用此參數可設定微調和額外選項的其他配置。 探索 PDF.co 知識庫 https://developer.pdf.co/api/profiles/index.html 以取得設定檔範例 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
JobId
|
jobId | string |
jobId |
|
URL
|
url | string |
url |
|
錯誤
|
error | boolean |
錯誤 |
|
地位
|
status | integer |
狀態 |
|
名稱
|
name | string |
名稱 |
|
學分
|
credits | integer |
credits |
|
剩餘積分
|
remainingCredits | integer |
剩餘學分 |
|
持續時間
|
duration | integer |
duration |
條碼閱讀器
從圖像和 PDF 中讀取條形碼。 可以讀取所有流行的條形碼類型,從 QR 碼和 Code 128、EAN 到 Datamatrix、PDF417、GS1 和許多其他條形碼。 請參閱 API 文件, https://developer.pdf.co/api/barcode-reader/index.html 以取得完整的指導方針。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
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、橢圓形、PatchCode、PDF417、Pharmacode、PostNet、PZN、QRCode、Rectangle、RoyalMail、RoyalMailKIX、Segment、Trioptic、UnderlinedField、UPCA、UPCE、UPU、VerticalLine。 |
|
頁面
|
pages | string |
Comma-Separated 要處理的頁面索引(或範圍)清單。 重要提示:第一頁從 0(零)開始。 若要設定範圍,請使用破折號 -,例如:0,2-5,7-。 要設置從索引到最後一頁的範圍,請使用如下範圍:2-(從索引從零開始的第 #3 頁開始,直到文檔末尾)。 對於所有頁面,只需將此參數留空即可。 範例:0,2-5,7-表示第一頁,然後是第3頁到第6頁,然後是從第8頁(索引=7)到文件結尾的範圍。 |
|
|
Profiles
|
profiles | string |
使用此參數可設定微調和額外選項的其他配置。 探索 PDF.co 知識庫 (https://developer.pdf.co/api/profiles/index.html) 以取得設定檔範例。 |
|
|
非同步
|
async | boolean |
將 async 設定為 true 以在背景執行長進程,API 隨後會傳回一個 jobId,您可以將其與 JobCheck 模組一起使用,以檢查進程的狀態並擷取輸出,同時您可以繼續執行其他任務,而無需等待此進程完成。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
JobId
|
jobId | string |
jobId |
|
URL
|
url | string |
url |
|
條碼
|
barcodes | array of object |
條碼 |
|
價值觀
|
barcodes.Value | string |
價值觀 |
|
類型
|
barcodes.Type | integer |
類型 |
|
矩形
|
barcodes.Rect | string |
矩形 |
|
頁面
|
barcodes.Page | integer |
頁面 |
|
檔案
|
barcodes.File | string |
檔案 |
|
信賴度
|
barcodes.Confidence | float |
信賴度 |
|
後設資料
|
barcodes.Metadata | string |
後設資料 |
|
類型名稱
|
barcodes.TypeName | string |
類型名稱 |
|
頁數
|
pageCount | integer |
頁數 |
|
錯誤
|
error | boolean |
錯誤 |
|
地位
|
status | integer |
狀態 |
|
學分
|
credits | integer |
credits |
|
剩餘積分
|
remainingCredits | integer |
剩餘學分 |
|
持續時間
|
duration | integer |
duration |
發送帶有附件的電子郵件
發送帶有附件的電子郵件。 請參閱 API 文件, https://developer.pdf.co/api/email-send-and-decode/index.html 以取得完整的指導方針。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
URL
|
url | True | string |
來源檔案的URL。 支援來自 Google Drive、Dropbox 和 PDF.co 內建檔案儲存的連結。 |
|
寄件者
|
from | True | string |
包含寄件者名稱和電子郵件的「寄件者」欄位。 範例:無名氏 john@example.com |
|
發往
|
to | True | string |
包含收件人姓名和電子郵件的「收件者」欄位。 範例:合作夥伴 partner@example.com |
|
主旨
|
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 |
將 async 設定為 true 以在背景執行長進程,API 接著會傳回 jobId,您可以搭配 JobCheck 端點使用,以檢查進程的狀態並擷取輸出,同時您可以繼續執行其他工作,而不需要等待此進程完成。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
工作識別碼
|
jobId | string |
jobId |
|
錯誤
|
error | boolean |
錯誤 |
|
地位
|
status | integer |
狀態 |
|
學分
|
credits | integer |
credits |
|
剩餘積分
|
remainingCredits | integer |
剩餘學分 |
|
持續時間
|
duration | integer |
duration |
背景工作檢查
檢查先前使用 API 建立的背景作業 PDF.co 狀態。 請參閱 API 文件, https://developer.pdf.co/api/background-job-check/index.html 以取得完整的指導方針。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
工作識別碼
|
jobid | True | string |
PDF.co 背景工作識別碼 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
地位
|
status | string |
狀態 |
|
網址
|
url | string |
url |
|
工作識別碼
|
jobId | string |
jobId |
|
持續時間
|
duration | integer |
duration |
試算表中的 PDF
從 XLS、XLSX 電子表格創建 PDF。 請參閱 API 文件, https://developer.pdf.co/api/convert-excel/index.html#post-tag-xls-convert-to-pdf 以取得完整的指導方針。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
URL
|
url | True | string |
來源檔案的URL。 支援來自 Google Drive、Dropbox 和 PDF.co 內建檔案儲存的連結。 |
|
工作表索引
|
worksheetIndex | string |
設定工作表索引 (預設值為 0)。 |
|
|
名稱
|
name | string |
產生輸出的檔案名稱。 |
|
|
Expiration
|
expiration | integer |
將輸出連結的到期時間設定為分鐘(預設為 60 或 60 分鐘或 1 小時),在此指定的持續時間之後,任何產生的輸出檔案都會自動從 PDF.co 暫存檔案儲存中刪除。 連結到期的最長持續時間會根據您目前的訂閱方案而有所不同。 |
|
|
非同步
|
async | boolean |
如果長程序在背景執行,API 會設定為 true,然後會傳回 jobId,您可以搭配 JobCheck 端點使用,以檢查程序的狀態並擷取輸出,同時您可以繼續執行其他工作,而不需要等待此程序完成。 |
|
|
Profiles
|
profiles | string |
您可以使用此參數設定其他和額外的選項,以設定自訂設定。 探索 PDF.co 知識庫 (https://developer.pdf.co/api/profiles/index.html) 以取得設定檔範例。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
URL
|
url | string | |
|
工作識別碼
|
jobId | string |
jobId |
|
頁數
|
pageCount | integer |
頁數 |
|
錯誤
|
error | boolean |
錯誤 |
|
地位
|
status | integer |
狀態 |
|
名稱
|
name | string |
名稱 |
|
學分
|
credits | integer |
credits |
|
剩餘積分
|
remainingCredits | integer |
剩餘學分 |
|
持續時間
|
duration | integer |
duration |
試算表轉 CSV
將 XLS/XLSX 轉換為 CSV 逗號分隔值文件。 請參閱 API 文件, https://developer.pdf.co/api/convert-excel/index.html#post-tag-xls-convert-to-csv 以取得完整的指導方針。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
URL
|
url | True | string |
來源檔案的URL。 支援來自 Google Drive、Dropbox 和 PDF.co 內建檔案儲存的連結。 |
|
工作表索引
|
worksheetIndex | string |
設定工作表索引 (預設值為 0)。 |
|
|
引號
|
quotationSymbol | string |
設定 CSV 報價符號 |
|
|
分隔符號
|
separatorSymbol | string |
設定 CSV 分隔符號 |
|
|
名稱
|
name | string |
產生輸出的檔案名稱。 |
|
|
Expiration
|
expiration | integer |
將輸出連結的到期時間設定為分鐘(預設為 60 或 60 分鐘或 1 小時),在此指定的持續時間之後,任何產生的輸出檔案都會自動從 PDF.co 暫存檔案儲存中刪除。 連結到期的最長持續時間會根據您目前的訂閱方案而有所不同。 |
|
|
非同步
|
async | boolean |
如果長程序在背景執行,API 會設定為 true,然後會傳回 jobId,您可以搭配 JobCheck 端點使用,以檢查程序的狀態並擷取輸出,同時您可以繼續執行其他工作,而不需要等待此程序完成。 |
|
|
Profiles
|
profiles | string |
您可以使用此參數設定其他和額外的選項,以設定自訂設定。 探索 PDF.co 知識庫 (https://developer.pdf.co/api/profiles/index.html) 以取得設定檔範例。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
URL
|
url | string |
url |
|
工作識別碼
|
jobId | string |
jobId |
|
錯誤
|
error | boolean |
錯誤 |
|
地位
|
status | integer |
狀態 |
|
名稱
|
name | string |
名稱 |
|
學分
|
credits | integer |
credits |
|
剩餘學分
|
remainingCredits | integer |
剩餘學分 |
|
持續時間
|
duration | integer |
duration |
試算表轉 HTML
將 XLS/XLSX 轉換為 HTML 文件。 請參閱 API 文件, https://developer.pdf.co/api/convert-excel/index.html#post-tag-xls-convert-to-html 以取得完整的指導方針。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
URL
|
url | True | string |
來源檔案的URL。 支援來自 Google Drive、Dropbox 和 PDF.co 內建檔案儲存的連結。 |
|
工作表索引
|
worksheetIndex | string |
設定工作表索引 (預設值為 0)。 |
|
|
名稱
|
name | string |
產生輸出的檔案名稱。 |
|
|
Expiration
|
expiration | integer |
將輸出連結的到期時間設定為分鐘(預設為 60 或 60 分鐘或 1 小時),在此指定的持續時間之後,任何產生的輸出檔案都會自動從 PDF.co 暫存檔案儲存中刪除。 連結到期的最長持續時間會根據您目前的訂閱方案而有所不同。 |
|
|
非同步
|
async | boolean |
如果長程序在背景執行,API 會設定為 true,然後會傳回 jobId,您可以搭配 JobCheck 端點使用,以檢查程序的狀態並擷取輸出,同時您可以繼續執行其他工作,而不需要等待此程序完成。 |
|
|
Profiles
|
profiles | string |
您可以使用此參數設定其他和額外的選項,以設定自訂設定。 探索 PDF.co 知識庫 (https://developer.pdf.co/api/profiles/index.html) 以取得設定檔範例。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
URL
|
url | string |
url |
|
工作識別碼
|
jobId | string |
jobId |
|
錯誤
|
error | boolean |
錯誤 |
|
地位
|
status | integer |
狀態 |
|
名稱
|
name | string |
名稱 |
|
學分
|
credits | integer |
credits |
|
剩餘學分
|
remainingCredits | integer |
剩餘學分 |
|
持續時間
|
duration | integer |
duration |
試算表轉 JSON
將 XLS/XLSX 轉換為 JSON 檔案。 請參閱 API 文件, https://developer.pdf.co/api/convert-excel/index.html#post-tag-xls-convert-to-json 以取得完整的指導方針。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
URL
|
url | True | string |
來源檔案的URL。 支援來自 Google Drive、Dropbox 和 PDF.co 內建檔案儲存的連結。 |
|
工作表索引
|
worksheetIndex | string |
設定工作表索引 (預設值為 0)。 |
|
|
名稱
|
name | string |
產生輸出的檔案名稱。 |
|
|
Expiration
|
expiration | integer |
將輸出連結的到期時間設定為分鐘(預設為 60 或 60 分鐘或 1 小時),在此指定的持續時間之後,任何產生的輸出檔案都會自動從 PDF.co 暫存檔案儲存中刪除。 連結到期的最長持續時間會根據您目前的訂閱方案而有所不同。 |
|
|
非同步
|
async | boolean |
如果長程序在背景執行,API 會設定為 true,然後會傳回 jobId,您可以搭配 JobCheck 端點使用,以檢查程序的狀態並擷取輸出,同時您可以繼續執行其他工作,而不需要等待此程序完成。 |
|
|
Profiles
|
profiles | string |
您可以使用此參數設定其他和額外的選項,以設定自訂設定。 探索 PDF.co 知識庫 (https://developer.pdf.co/api/profiles/index.html) 以取得設定檔範例。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
URL
|
url | string |
url |
|
工作識別碼
|
jobId | string |
jobId |
|
錯誤
|
error | boolean |
錯誤 |
|
地位
|
status | integer |
狀態 |
|
名稱
|
name | string |
名稱 |
|
學分
|
credits | integer |
credits |
|
剩餘學分
|
remainingCredits | integer |
剩餘學分 |
|
持續時間
|
duration | integer |
duration |
試算表轉 XML
將 XLS/XLSX 或 CSV 轉換為 XML 文件。 請參閱 API 文件, https://developer.pdf.co/api/convert-excel/index.html#post-tag-xls-convert-to-xml 以取得完整的指導方針。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
URL
|
url | True | string |
來源檔案的URL。 支援來自 Google Drive、Dropbox 和 PDF.co 內建檔案儲存的連結。 |
|
工作表索引
|
worksheetIndex | string |
設定工作表索引 (預設值為 0)。 |
|
|
名稱
|
name | string |
產生輸出的檔案名稱。 |
|
|
Expiration
|
expiration | integer |
將輸出連結的到期時間設定為分鐘(預設為 60 或 60 分鐘或 1 小時),在此指定的持續時間之後,任何產生的輸出檔案都會自動從 PDF.co 暫存檔案儲存中刪除。 連結到期的最長持續時間會根據您目前的訂閱方案而有所不同。 |
|
|
非同步
|
async | boolean |
如果長程序在背景執行,API 會設定為 true,然後會傳回 jobId,您可以搭配 JobCheck 端點使用,以檢查程序的狀態並擷取輸出,同時您可以繼續執行其他工作,而不需要等待此程序完成。 |
|
|
Profiles
|
profiles | string |
您可以使用此參數設定其他和額外的選項,以設定自訂設定。 探索 PDF.co 知識庫 (https://developer.pdf.co/api/profiles/index.html) 以取得設定檔範例。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
URL
|
url | string |
url |
|
工作識別碼
|
jobId | string |
jobId |
|
錯誤
|
error | boolean |
錯誤 |
|
地位
|
status | integer |
狀態 |
|
名稱
|
name | string |
名稱 |
|
學分
|
credits | integer |
credits |
|
剩餘學分
|
remainingCredits | integer |
剩餘學分 |
|
持續時間
|
duration | integer |
duration |
電子表格轉 TXT
將 XLS/XLSX 或 CSV 轉換為文本文件。 請參閱 API 文件, https://developer.pdf.co/api/convert-excel/index.html#post-tag-xls-convert-to-txt 以取得完整的指導方針。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
URL
|
url | True | string |
來源檔案的URL。 支援來自 Google Drive、Dropbox 和 PDF.co 內建檔案儲存的連結。 |
|
工作表索引
|
worksheetIndex | string |
設定工作表索引 (預設值為 0)。 |
|
|
名稱
|
name | string |
產生輸出的檔案名稱。 |
|
|
Expiration
|
expiration | integer |
將輸出連結的到期時間設定為分鐘(預設為 60 或 60 分鐘或 1 小時),在此指定的持續時間之後,任何產生的輸出檔案都會自動從 PDF.co 暫存檔案儲存中刪除。 連結到期的最長持續時間會根據您目前的訂閱方案而有所不同。 |
|
|
非同步
|
async | boolean |
如果長程序在背景執行,API 會設定為 true,然後會傳回 jobId,您可以搭配 JobCheck 端點使用,以檢查程序的狀態並擷取輸出,同時您可以繼續執行其他工作,而不需要等待此程序完成。 |
|
|
Profiles
|
profiles | string |
您可以使用此參數設定其他和額外的選項,以設定自訂設定。 探索 PDF.co 知識庫 (https://developer.pdf.co/api/profiles/index.html) 以取得設定檔範例。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
URL
|
url | string |
url |
|
工作識別碼
|
jobId | string |
jobId |
|
錯誤
|
error | boolean |
錯誤 |
|
地位
|
status | integer |
狀態 |
|
名稱
|
name | string |
名稱 |
|
學分
|
credits | integer |
credits |
|
剩餘學分
|
remainingCredits | integer |
剩餘學分 |
|
持續時間
|
duration | integer |
duration |
電子郵件資訊
獲取電子郵件信息,例如發件人/收件人、主題、正文等。請參閱 API 文件, https://developer.pdf.co/api/email-send-and-decode/index.html#post-tag-email-decode 以取得完整的指導方針。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
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 |
將 async 設定為 true 以在背景執行長進程,API 接著會傳回 jobId,您可以搭配 JobCheck 端點使用,以檢查進程的狀態並擷取輸出,同時您可以繼續執行其他工作,而不需要等待此進程完成。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
URL
|
url | string |
url |
|
寄件者
|
body.from | string | |
|
寄件者名稱
|
body.fromName | string | |
|
至
|
body.to | array of object | |
|
Address
|
body.to.address | string | |
|
名稱
|
body.to.Name | string |
名稱 |
|
副本
|
body.cc | array of object | |
|
Address
|
body.cc.address | string | |
|
名稱
|
body.cc.Name | string |
名稱 |
|
密件副本
|
body.bcc | array of object | |
|
Address
|
body.bcc.address | string | |
|
名稱
|
body.bcc.Name | string |
名稱 |
|
發送時間
|
body.sentAt | string | |
|
收稿日期
|
body.receivedAt | string | |
|
主旨
|
body.subject | string | |
|
正文 (HTML)
|
body.bodyHtml | string | |
|
正文(文字)
|
body.bodyText | string | |
|
附件計數
|
body.attachmentCount | integer | |
|
工作識別碼
|
jobId | string |
jobId |
|
錯誤
|
error | boolean |
錯誤 |
|
地位
|
status | integer |
狀態 |
|
名稱
|
name | string |
名稱 |
|
學分
|
credits | integer |
credits |
|
剩餘積分
|
remainingCredits | integer |
剩餘學分 |
|
持續時間
|
duration | integer |
duration |
電子郵件附件提取
提取包含基本電子郵件信息的電子郵件附件。 請參閱 API 文件, https://developer.pdf.co/api/email-send-and-decode/index.html#post-tag-email-extract-attachments 以取得完整的指導方針。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
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 |
將 async 設定為 true 以在背景執行長進程,API 接著會傳回 jobId,您可以搭配 JobCheck 端點使用,以檢查進程的狀態並擷取輸出,同時您可以繼續執行其他工作,而不需要等待此進程完成。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
URL
|
url | string |
url |
|
寄件者
|
body.from | string | |
|
主旨
|
body.subject | string | |
|
正文 (HTML)
|
body.bodyHtml | string | |
|
正文(文字)
|
body.bodyText | string | |
|
attachments
|
body.attachments | array of object | |
|
檔案名稱
|
body.attachments.filename | string | |
|
內容ID
|
body.attachments.contentid | string |
內容 ID |
|
url
|
body.attachments.url | string |
URL |
|
檔案大小以位元組為單位
|
body.attachments.filesizeinbytes | integer |
檔案大小 (以位元組為單位) |
|
工作識別碼
|
jobId | string |
jobId |
|
錯誤
|
error | boolean |
錯誤 |
|
地位
|
status | integer |
狀態 |
|
名稱
|
name | string |
名稱 |
|
學分
|
credits | integer |
credits |
|
剩餘積分
|
remainingCredits | integer |
剩餘學分 |
|
持續時間
|
duration | integer |
duration |