跳到內容

文件與文檔工具

OmniDoc 提供同步檔案工具和可追蹤的非同步文件作業。請先呼叫能力端點,切勿在用戶端硬編寫支援範圍或限額。

GET /api/v1/document-operations/capabilities
GET /api/v1/artifacts/convert/capabilities

返回目前開放的操作、輸入格式、計費方式及技術上限。unavailable 中的能力無法建立。

POST /api/v1/document-operations
Idempotency-Key: unique-request-id
{
"document_id": "4q8mx2q9z1k7p6ra",
"kind": "visual_extract"
}

本介面必須攜帶 Idempotency-Key。kind 目前包括:

  • extract:結構化提取,免費。
  • pdf_to_html:PDF 轉為線上 HTML,免費。
  • visual_extract:視覺結構化提取,按頁計費(每頁 1 积分)。開始前按餘額確定可處理的頁數(最多 20 頁),餘額不足 1 頁時返回 402;完成後按實際處理的頁數扣費,餘額可能變為負數。

查詢與取消:

GET /api/v1/document-operations/{operation_id}
GET /api/v1/document-operations?limit=25
POST /api/v1/document-operations/{operation_id}/cancel

完成後,回應中的 output_document_id 可繼續進入檔案庫或其他任務,credit_operation_id 可查詢結算憑證。

POST /api/v1/file-tools/pdf/merge
POST /api/v1/file-tools/pdf/split
POST /api/v1/file-tools/pdf/compress

合併示例:

{"document_ids":["4q8mx2q9z1k7p6ra","b6t1n8c3v9m2x5ka"]}

拆分示例:

{"document_id":"4q8mx2q9z1k7p6ra","ranges":["1-3","5","8-10"]}
POST /api/v1/file-tools/image/convert
POST /api/v1/file-tools/image/compress
{
"document_id": "4q8mx2q9z1k7p6ra",
"target_format": "webp",
"quality": 85
}

工具只接受當前帳號擁有且類型匹配的文檔。對二進制回應使用串流下載,並依據回應標頭保存檔名和類型。