Lewati ke konten

Alat dokumentasi dan berkas

OmniDoc menawarkan alat berkas sinkron dan operasi dokumen asinkron yang dapat dilacak. Panggil endpoint kapabilitas terlebih dahulu; jangan mengkodekan secara langsung format atau batasan yang didukung di sisi klien.

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

Ini mengembalikan operasi yang saat ini terbuka, format inputnya, serta batas penagihan dan teknis. Kemampuan yang tercantum di bawah unavailable tidak dapat dibuat.

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

Endpoint ini memerlukan Idempotency-Key. kind saat ini mencakup:

  • extract: ekstraksi terstruktur, gratis.
  • pdf_to_html: PDF ke online HTML, gratis.
  • visual_extract: ekstraksi terstruktur visual, dikenakan biaya per halaman (1 kredit per halaman). Sebelum dimulai, jumlah halaman yang dapat diproses ditentukan berdasarkan saldo (maksimal 20 halaman); jika saldo hanya mencukupi untuk kurang dari 1 halaman, sistem akan mengembalikan 402. Setelah selesai, halaman yang benar-benar diproses akan ditagih, dan saldo dapat menjadi negatif.

Kueri dan batalkan:

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

Setelah selesai, output_document_id dari respons dapat dimasukkan ke dalam pustaka file atau pekerjaan lain, dan credit_operation_id memberikan catatan penyelesaian.

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

Contoh penggabungan:

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

Contoh pemisahan:

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

Alat-alat tersebut hanya menerima dokumen yang dimiliki oleh akun saat ini dan memiliki tipe yang sesuai. Alirkan respons biner, serta ambil nama file dan tipenya dari header respons.