API اور ویب ہوکس
ریسٹ API کے ذریعے دستاویزات کو اپ لوڈ اور پڑھنا دستیاب ہے۔ اکاؤنٹ، فائلوں، ٹیگوں اور روابط کا انتظام ایپلیکیشن میں رہتا ہے۔
کلید
یہ سیٹنگز → ڈویلپرز کے لیے میں قائم کی جاتی ہے۔ کلید ایک بار، تشکیل کے وقت ظاہر ہوتی ہے — پھر نہیں، کیونکہ صرف اس کے ہیش کو محفوظ کیا جاتا ہے۔ کھوئی ہوئی کلید کو بحال نہیں کیا جاتا، ایک نئی بنائی جاتی ہے اور پرانی کو حذف کر دیا جاتا ہے۔ پانچ کلیدیں رکھی جا سکتی ہیں، ہر ایک کی اختیاری میعاد دو سال تک ہو سکتی ہے۔
کلید کو X-API-Key ہیڈر میں بھیجا جاتا ہے۔
API کیا کر سکتا ہے
| آپریشن | وضاحت |
|---|---|
POST /api/upload | فائل اپ لوڈ کریں جس میں اختیارات: شکل، سمت، قسم، کرنسی، اسکیمہ، فائل، ویب ہوک |
POST /api/upload/url | عمومی ایڈریس سے ایسا ہی؛ ہم خود فائل ڈاؤن لوڈ کریں گے |
GET /api/jobs | دستاویزات کی فہرست فلٹرز اور صفحہ بندی کے ساتھ |
GET /api/jobs/{id} | حیثیت، پڑھی گئی معلومات، نتائج اور ہدف فارمیٹ میں نتیجہ |
GET /api/jobs/{id}/original | اپ لوڈ کی گئی فائل |
DELETE /api/jobs/{id} | کوڑے والی ٹوکری میں حذف کرنا |
ایکس ایل اور پی ڈی ایف نتیجے میں Base64 کی شکل میں ہوتے ہیں۔ جو نتیجہ نہیں چاہتا، وہ includeResult=false بھیجے، اس طرح سرور پر تبدیلی بچ جاتی ہے۔
OpenAPI فارمیٹ میں انٹرفیس کی وضاحت /api/docs پر ہے؛ یہ سیٹنگز میں کلیدوں کے ساتھ ہے۔ یہ وضاحت چلتے کوڈ سے تیار کی جاتی ہے، اس لیے جو API کرتا ہے اس کے مطابق ہوتی ہے۔
API سے دستاویزات کی جانچ
پیشگی جانچ کا اطلاق ڈیفالٹ طور پر کلید سے اپ لوڈ کردہ دستاویزات پر بھی ہوتا ہے: دستاویز کی ایپلیکیشن میں تصدیق کا انتظار ہوتا ہے اور ویب ہوک اس کے بعد بھیجی جائے گی۔ جو انضمام کی تعمیر کر رہا ہے جس کے لیے کوئی اسکرین کے سامنے نہیں بیٹھتا، وہ سیٹنگز → پیشگی جانچ سے API چینل ہٹا سکتا ہے، یا جانچ کو بند کر سکتا ہے۔
MCP
AI ایجنٹ کے لیے /api/mcp پر MCP سرور ایک ہی کلید کے ساتھ ہے۔ یہ دستاویزات پڑھ سکتا ہے اور تلاش کر سکتا ہے، اپ لوڈ نہیں کر سکتا؛ اپ لوڈ ایک مکمل حکم کے طور پر واپس کر دیتا ہے، جو ایجنٹ خود چلا سکتا ہے۔
ویب ہوکس
حالت کی جانچ کے بجائے، جب کام ختم ہو جائے تو نتیجہ بھیجنے کے لیے چھوڑ دیں۔ ایڈریس کو پوری اسٹوریج کے لیے سیٹنگز → ڈویلپرز کے لیے میں ترتیب دیا جاتا ہے، یا کسی خاص اپ لوڈ کے لیے targetWebhookUrl پیرامیٹر کے ذریعے۔ سیٹنگز میں ایک بٹن ٹیسٹ پیغام بھیجے گا۔
ایک POST JSON بھیجا جائے گا: دستاویز کا شناخت کنندہ، فائل کا نام، شکل اور ہدف فارمیٹ میں نتیجہ۔ جب دستاویز جانچ میں کامیاب ہو جاتی ہے یا دوبارہ پروسیس کی جاتی ہے، تو ویب ہوک دوبارہ IsCorrection علامت کے ساتھ آتا ہے۔
پیغام پر دستخط نہیں کیے جاتے ہیں۔ اپنے خفیہ ٹوکن کو ایڈریس میں شامل کر کے بھیجنے والے کی تصدیق کریں۔ پرائیویٹ نیٹ ورکس کے ایڈریس مسترد کیے جاتے ہیں۔
ناکام ترسیل کو بڑھتی ہوئی تاخیر کے ساتھ دہرانا ہوتا ہے، تقریباً چار اور آدھے گھنٹے میں گیارہ کوششیں۔ ہر کوشش آپ کی طرف سے جواب کے ساتھ سرگرمی میں ہوتی ہے؛ دستاویز کی فہرست میں وصولی کے نتیجے کے ساتھ ایک آئیکون ہوتا ہے۔
حدود
API کے پاس فی منٹ کالز کی تعداد کے لیے کوئی مخصوص حد نہیں ہے؛ اپ لوڈنگ کو کریڈٹس، فائل کے سائز کے مطابق ٹیرائف اور ہر دستاویز پر بیس صفحات کے ساتھ محدود کیا گیا ہے۔ رد کر دیا جانے والا پیغام خطا 400 کے ساتھ آتا ہے جس میں بتاتا ہے کیوں۔ MCP سرور کو فی سیکنڈ دس سوالات تک محدود کیا گیا ہے۔