تخطَّ إلى المحتوى

نظرة عامة على واجهة برمجة التطبيقات

Base URL

https://omnidoc.top/api/v1

أرسل Content-Type: application/json مع طلبات JSON. يُوضع مفتاح API في رأس X-API-Key أو كبيان اعتماد Bearer.

الخدمةالمسارات الرئيسيةالغرض
تحميل الملف/upload/*تحميل المستندات وتأكيدها
مكتبة الملفات/storage/files/*, /documents/*قائمة، قراءة وتنزيل
الترجمة/jobs/*, /artifacts/*إنشاء المهام، والتحقق من الحالة والنتائج
أدوات المستند/document-operations/*, /file-tools/*التحويل، الدمج، التقسيم، الضغط وغير ذلك
ترجمة فورية/ai/*ترجمة النصوص القصيرة وأجزاء الدُفعات
الصوت والفيديو/media-jobs/*, /media-voices/*الوظائف والأصوات
قواميس المصطلحات/glossaries/*المصطلحات، الاستيراد والتصدير
الاستخدام والاعتمادات/usage/*, /billing/credits/*سجلات الاستخدام والتوازن والتسوية
الإشعارات/sse/*, /webhooks/*التقدم المباشر والاتصالات العكسية

الخدمات التي يمكنك استدعاءها وتكاليفها: الخدمات والأذونات .

  • معرّفات الموارد هي سلاسل نصية غير قابلة للقراءة المباشرة.
  • أرسل Idempotency-Key مع طلبات الإنشاء؛ تتطلب العمليات الوثائقية ووظائف الوسائط وإنشاء الصوت واحدًا منها.
  • يتم وصف معلمات الترقيم على صفحة كل نقطة نهاية.
  • Handle 429 كما هو موصوف في errors and retries .
  • أسماء الملفات التي تم تنزيلها مخصصة للعرض فقط؛ استخدم الاسم الأساسي وطبّق حدود نظام الملفات لديك قبل الحفظ.

احتفظ بـ X-Request-Id في كل استجابة. عند التواصل مع فريق الدعم، قدم تلك القيمة ووقت الطلب والمسار؛ ولا ترسل مفتاح API الكامل أو محتويات الملف أبداً.