Bỏ qua để đến nội dung

Công cụ tài liệu và tệp

OmniDoc cung cấp các công cụ tệp đồng bộ và các thao tác tài liệu không đồng bộ có thể theo dõi. Trước tiên, hãy gọi các điểm cuối chức năng; không mã cứng các định dạng hoặc giới hạn được hỗ trợ trong máy khách.

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

Chúng trả về các thao tác hiện đang mở, định dạng đầu vào, giới hạn tính phí và giới hạn kỹ thuật của chúng. Các khả năng được liệt kê dưới unavailable không thể được tạo.

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

Điểm cuối này yêu cầu một Idempotency-Key. kind hiện bao gồm:

  • extract: trích xuất có cấu trúc, miễn phí.
  • pdf_to_html: PDF sang trực tuyến HTML, miễn phí.
  • visual_extract: trích xuất có cấu trúc trực quan, tính phí theo số trang (1 tín dụng mỗi trang). Trước khi bắt đầu, số trang có thể xử lý được xác định dựa trên số dư (tối đa 20 trang); nếu số dư chỉ đủ cho chưa đến 1 trang, hệ thống trả về 402. Khi hoàn tất, chỉ những trang thực tế đã được xử lý mới bị tính phí, và số dư có thể trở thành âm.

Truy vấn và hủy:

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

Khi hoàn tất, output_document_id của phản hồi có thể được đưa vào thư viện tệp hoặc chuyển sang một tác vụ khác, còn credit_operation_id cung cấp bản ghi thanh toán.

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

Ví dụ về hợp nhất:

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

Ví dụ tách:

{"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
}

Các công cụ chỉ chấp nhận tài liệu thuộc sở hữu của tài khoản hiện tại và có kiểu dữ liệu phù hợp. Truyền phản hồi nhị phân, đồng thời lấy tên tệp và kiểu dữ liệu từ các tiêu đề phản hồi.