مواد پر جائیں
NEBULA

nebula@atheron:/ur/docs$

// دستاویزات

ہر کام کے لیے ایک ⁨API⁩

⁨REST⁩، ⁨JSON⁩ اور ایک ویب ہک۔

بیچ جمع کریں، اسے دیکھیں اور نتیجہ ڈاؤن لوڈ کریں۔ مکمل حوالہ ڈویلپر پورٹل میں آپ کی کلیدوں کے ساتھ ہے۔

کلیدیں

جب آپ کی ٹیم کاروباری جانچ مکمل کر لے اور کارڈ شامل کر دے تو ڈویلپر پورٹل میں کلیدیں بنائیں۔ کلید کو ⁨Bearer⁩ ٹوکن کے طور پر بھیجیں۔

  • ٹیسٹ کلیدیں ⁨ath_test_⁩ سے شروع ہوتی ہیں، ⁨Atheron⁩ کی اپنی مشینوں پر ہر بیچ میں 100 آئٹمز تک چلاتی ہیں، اور کبھی آپ کے کارڈ سے رقم نہیں لیتیں
  • لائیو کلیدیں ⁨ath_live_⁩ سے شروع ہوتی ہیں اور اصل کام چلاتی ہیں
  • کام جمع کرنے کے لیے کلید کو ⁨nebula⁩ کا حق چاہیے
  • کلیدیں صرف ایک بار دکھائی جاتی ہیں اور صرف ہیش کی صورت میں محفوظ ہوتی ہیں

ویب ہکس

بیچ مکمل ہونے پر ہم آپ کے ویب ہک پتے پر ⁨batch.completed⁩ بھیجتے ہیں، دستخط کے ساتھ تاکہ آپ جانچ سکیں کہ یہ ہماری طرف سے ہے۔ ناکام ترسیل 3 دن تک دوبارہ کی جاتی ہے۔

مکمل حوالے میں

  • فوری آغاز
  • کام اور ماڈلز
  • ان پٹ کی شکلیں
  • نتائج اور محفوظ رکھنا
  • قابلِ اشتراک اور نجی کام
  • فائن ٹیوننگ کے کام
  • ویب ہکس اور دستخط
  • غلطیاں اور حدیں
  • استعمال اور بلنگ

اینڈ پوائنٹس

ہر درخواست اور جواب ⁨JSON⁩ میں ہے۔

  • POST /api/v1/nebula/batches

    بیچ جمع کریں: کام، ماڈل، آپ کی اشیاء، آیا یہ قابلِ اشتراک ہے، اور ویب ہک کا پتہ۔

  • GET /api/v1/nebula/batches/{id}

    بیچ کی حالت اور کتنے حصے مکمل ہو چکے۔

  • GET /api/v1/nebula/batches/{id}/results

    بیچ مکمل ہونے پر نتائج کی فائل کا مختصر مدت کا لنک۔

  • POST /api/v1/nebula/batches/{id}/cancel

    بیچ روکیں۔ مکمل حصے محفوظ رہتے ہیں اور ان کا بل بنتا ہے۔

  • GET /api/v1/nebula/models

    ماڈلز کا کیٹلاگ، ہر ماڈل کے کام، لائسنس اور حدود کے ساتھ۔

مثال

بیچ جمع کریں
curl https://developers.aton-network.org/api/v1/nebula/batches \
  -H "Authorization: Bearer $ATHERON_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "task": "embed",
    "model": "bge-base-en-v1.5",
    "shareable": false,
    "items": [
      { "id": "doc-1", "text": "Machine learning on a shared network." },
      { "id": "doc-2", "text": "Every result is checked twice." }
    ],
    "webhook": "https://example.com/hooks/nebula"
  }'
اس کی حالت دیکھیں
curl https://developers.aton-network.org/api/v1/nebula/batches/bat_123 \
  -H "Authorization: Bearer $ATHERON_KEY"

{ "id": "bat_123", "state": "running", "shards": { "done": 12, "total": 40 } }

کوئی سوال جس کا جواب دستاویزات میں نہیں؟ ہماری ٹیم سے بات کریں۔