Gambaran umum platform
API OmniDoc melayani alur kerja berkas dan konten dalam satu akun. Pemanggil membuat sumber daya dengan kunci API, lalu menggunakan ID stabil yang diterimanya untuk melakukan query, menggabungkan, memproses, atau mengunduh sumber daya tersebut.
Model sumber daya
Section titled “Model sumber daya”| Sumber daya | Tujuan |
|---|---|
| Dokumen / Berkas | File sumber dan entri pustaka file yang dimiliki oleh akun tersebut |
| Pekerjaan / Operasi | Penerjemahan asinkron, pemrosesan dokumen, atau pekerjaan audio dan video |
| Artifact | Hasil yang disampaikan pekerjaan untuk pratinjau atau unduhan |
| Operasi kredit | Catatan tentang tindakan yang dapat ditagihkan, termasuk biaya dan pengembalian dana |
Setiap sumber daya diperiksa berdasarkan akun pemiliknya. Klien hanya perlu menyimpan ID publik, dan tidak boleh menyimpulkan rincian implementasi dari ID, nama file, atau alamat unduhan.
Alur panggilan umum
Section titled “Alur panggilan umum”- Buat atau pilih sumber daya input.
- Pastikan akun memiliki kredit: saldo diperiksa terhadap ambang batas sebelum pekerjaan dimulai, dan penggunaan aktual ditagihkan saat pekerjaan selesai.
- Buat pekerjaan dengan
Idempotency-Key. - Periksa status pekerjaan; pekerjaan penerjemahan file juga dapat menggunakan SSE atau webhook.
- Baca hasil dan catatan kredit untuk pekerjaan ini.
Identitas
Section titled “Identitas”Integrasi eksternal selalu menggunakan kunci API, dengan izin yang sama seperti akun yang membuat kunci tersebut. Lihat autentikasi .
Mulai cepat → Unggah file, buat pekerjaan, periksa statusnya, dan unduh hasilnya