حالة الوظيفة
GET /api/v1/jobs/{job_id}لا تستهلك الاستعلام سوى قراءة الحالة ولا تُستخدم أي رصيد.
curl https://omnidoc.top/api/v1/jobs/q3f8s6c2a9m1k4tx \ -H "X-API-Key: $OMNIDOC_API_KEY"حالات دورة الحياة
Section titled “حالات دورة الحياة”status | المعنى |
|---|---|
pending | تم الإنشاء، في انتظار المعالجة في قائمة الانتظار |
processing | جارٍ المعالجة |
completed | تم الانتهاء؛ يمكن قراءة النتائج |
failed | فشل أو أُلغي؛ راجع error_msg |
يُخبرك status بما إذا كانت المهمة قد انتهت.
مراحل التقدم
Section titled “مراحل التقدم”stage | المعنى |
|---|---|
queued | في قائمة الانتظار |
accepted / preflight | مقبول وجاهز للإعداد |
translating | الترجمة |
writing_artifacts / finalizing | إنشاء النتائج وتسجيلها |
completed / failed | انتهى |
stage_progress هو شريط تقدم يعرض الحالة من 0 إلى 100؛ ولا يُستخدم في الفوترة. أثناء الانتظار في قائمة الانتظار، قد يعرض queue_position عدد الوظائف المتقدمة، أو قد يكون null.
قائمة وإلغاء
Section titled “قائمة وإلغاء”GET /api/v1/jobs?limit=20&before=2026-10-01T12:00:00ZPOST /api/v1/jobs/{job_id}/cancelالإلغاء يتم بجهد مبذول؛ الوظيفة التي انتهت بالفعل تُرجع 409. لا تُفرض رسوم على الوظائف الملغاة، ويمكنك التحقق من ذلك في سجل الائتمان.
احصل على النتائج
Section titled “احصل على النتائج”بعد اكتمال المهمة:
GET /api/v1/artifacts?job_id={job_id}قائمة النتائج فارغة بينما لا تزال المهمة قيد التنفيذ.