Lewati ke konten

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.

Sumber dayaTujuan
Dokumen / BerkasFile sumber dan entri pustaka file yang dimiliki oleh akun tersebut
Pekerjaan / OperasiPenerjemahan asinkron, pemrosesan dokumen, atau pekerjaan audio dan video
ArtifactHasil yang disampaikan pekerjaan untuk pratinjau atau unduhan
Operasi kreditCatatan 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.

  1. Buat atau pilih sumber daya input.
  2. Pastikan akun memiliki kredit: saldo diperiksa terhadap ambang batas sebelum pekerjaan dimulai, dan penggunaan aktual ditagihkan saat pekerjaan selesai.
  3. Buat pekerjaan dengan Idempotency-Key.
  4. Periksa status pekerjaan; pekerjaan penerjemahan file juga dapat menggunakan SSE atau webhook.
  5. Baca hasil dan catatan kredit untuk pekerjaan ini.

Integrasi eksternal selalu menggunakan kunci API, dengan izin yang sama seperti akun yang membuat kunci tersebut. Lihat autentikasi .