Ikhtisar API
Base URL
https://omnidoc.top/api/v1Kirim Content-Type: application/json dengan permintaan JSON. Kunci API dimasukkan ke dalam header X-API-Key atau sebagai kredensial Bearer.
Layanan
Section titled “Layanan”| Layanan | Jalur utama | Tujuan |
|---|---|---|
| Unggah file | /upload/* | Unggah dan konfirmasi dokumen |
| Pustaka file | /storage/files/*, /documents/* | Daftar, baca, dan unduh |
| Terjemahan | /jobs/*, /artifacts/* | Buat pekerjaan, periksa status dan hasilnya |
| Alat dokumentasi | /document-operations/*, /file-tools/* | Konversi, gabungkan, pisahkan, kompres, dan lainnya |
| Terjemahan instan | /ai/* | Terjemahan teks singkat dan segmen batch |
| Audio dan video | /media-jobs/*, /media-voices/* | Pekerjaan dan suara |
| Glosarium | /glossaries/* | Istilah, impor dan ekspor |
| Penggunaan dan kredit | /usage/*, /billing/credits/* | Catatan penggunaan, saldo, dan penyelesaian |
| Notifikasi | /sse/*, /webhooks/* | Kemajuan langsung dan panggilan balik |
Layanan apa saja yang dapat Anda panggil dan berapa biayanya: layanan dan izin .
Konvensi
Section titled “Konvensi”- ID sumber daya adalah string yang tidak dapat diterjemahkan.
- Kirim
Idempotency-Keydengan permintaan pembuatan; operasi dokumentasi, pekerjaan media, dan pembuatan suara memerlukan satu. - Parameter pagination dijelaskan pada halaman masing-masing endpoint.
- Handle
429seperti yang dijelaskan dalam errors and retries . - Nama file yang diunduh hanya untuk tampilan; ambil nama dasar file dan terapkan batasan sistem berkas Anda sebelum menyimpan.
Pelacakan permintaan
Section titled “Pelacakan permintaan”Pertahankan X-Request-Id dari setiap respons. Saat menghubungi dukungan, sampaikan nilai tersebut, waktu permintaan, dan jalur; jangan pernah mengirimkan kunci API lengkap atau isi file.