API اور ویب ہکس
بلزاور پڑھائی کی تمام دستاویزات REST 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} | کوڑے دان میں حذف |
ایکسین اور PDF نتیجے میں Base64 کے طور پر ہوتے ہیں۔ جو لوگ نتیجہ نہیں چاہتے، وہ includeResult=false بھیج سکتے ہیں، اس طرح سرور پر کنورژن کی بچت کریں گے۔
OpenAPI فارمیٹ میں انٹرفیس کی وضاحت /api/docs پر ہے؛ یہ لنک سیٹنگز میں کلیدوں کے قریب ہے۔ وضاحت چلتے ہوئے کوڈ سے پیدا ہوتی ہے، لہذا یہ وہی ہے جو API کرتا ہے۔
API سے دستاویزات پر کنٹرول
پیشگی کنٹرول ڈیفالٹ کے طور پر کلید سے اپلوڈ کردہ دستاویزات پر بھی لاگو ہوتا ہے: دستاویز ایپ میں تصدیق کا انتظار کرتی ہے اور ویب ہک اس کے بعد بھیجا جاتا ہے۔ جو لوگ ایسی انضمام تیار کر رہے ہیں جس پر کوئی اسکرین کے سامنے نہیں بیٹھا، وہ سیٹنگز → پیشگی کنٹرول میں API چینل کو ہٹا سکتے ہیں، یا کنٹرول کو بند کر سکتے ہیں۔
MCP
AI ایجنٹس کے لیے /api/mcp پر اسی کلید کے ساتھ MCP سرور ہے۔ یہ دستاویزات کو پڑھ سکتا ہے اور تلاش کر سکتا ہے، لیکن اپلوڈ نہیں کر سکتا؛ اپلوڈ کو مکمل کمانڈ کی صورت میں واپس کرتا ہے، جسے ایجنٹ خود چلا لیتا ہے۔
ویب ہکس
حالت کی جانچ کرنے کے بجائے، جب کام ختم ہوجائے تو نتیجہ بھیجنے کے لیے کہیں۔ ایڈریس پورے اکاؤنٹ کے لیے سیٹنگز → ترقی دہندگان میں سیٹ کیا جاتا ہے، یا انفرادی اپلوڈ میں targetWebhookUrl پیرامیٹر کے ذریعے۔ سیٹنگ میں بٹن ایک ٹیسٹ پیغام بھیجتا ہے۔
ایک POST JSON بھیجا جاتا ہے: دستاویز کا شناختی نمبر، فائل کا نام، فارمات اور ہدف فارمیٹ میں نتیجہ۔ جب دستاویز کنٹرول میں کامیاب ہو جاتی ہے یا دوبارہ پروسیس کی جاتی ہے، تو ویب ہک دوسری بار درستگی کے علامت (IsCorrection) کے ساتھ بھیجا جاتا ہے۔
پیغام پر دستخط نہیں کیے جاتے۔ بھیجنے والے کی تصدیق کریں کہ ایڈریس میں اپنا خفیہ کوڈ شامل کریں۔ پرائیویٹ نیٹ ورکس کے ایڈریس مسترد کردیے جاتے ہیں۔
جب ویب ہک تمام کوششوں کے بعد بھی نہیں پہنچتا، تقریباً ساڑھے چار گھنٹوں کے بعد، ایک ای میل بھیجا جاتا ہے۔ ایک ہی خرابی پر صرف ایک بار، مزید ناکامیاں سرگرمی میں دیکھی جاتی ہیں۔ ای میل ہر بار بھیجا جاتا ہے جب ویب ہک کا ایڈریس تبدیل ہوتا ہے، اگر یہ آپ کے علاوہ کسی اور نے تبدیل کیا ہو۔
ناکام ترسیل کو بڑھتی ہوئی تاخیر سے بار بار بھیجا جاتا ہے، تقریباً ساڑھے چار گھنٹوں میں گیارہ کوششیں۔ ہر کوشش سرگرمی میں آپ کی جانب سے جواب کے ساتھ ہوتی ہے؛ دستاویز کی فہرست میں ترسیل کے نتیجے کے ساتھ ایک آئیکن ہوتا ہے۔
حدود
API کے پاس فی منٹ کالز کی تعداد کے لیے اپنی حد نہیں ہے؛ اپلوڈ کی تعداد کریڈٹس، فائل کا سائز ٹیرف کے مطابق اور ہر دستاویز کے لیے بیس صفحات سے محدود ہوتی ہے۔ مسترد ہونا ایک غلطی 400 کے طور پر آتا ہے جس میں ایک کوڈ ہوتا ہے جو بتاتا ہے کہ کیوں۔ MCP سرور پر ایک سیکنڈ میں دس درخواستوں کی حد ہے۔