API

تتيح واجهة Skynet HTTP API للسكربتات والأدوات أن تفعل ما يفعله تطبيق الويب: بدء عمليات التشغيل، ومتابعتها، وقراءة النتائج. توضّح هذه الصفحة كيف توقّع الطلبات، وأين تجد المرجع الكامل، وتقدّم مثالًا كاملًا واحدًا.

عنوان URL الأساسي

أرسل كل طلب إلى:

https://api.skynetml.com

المصادقة

تستخدم الواجهة رموز API.

1. افتح الإعدادات في Skynet، ثم افتح علامة التبويب API.
2. انقر توليد رمز.
3. انسخ الرمز فورًا. يعرض Skynet الرمز الكامل مرة واحدة فقط.

أرسل الرمز في الترويسة Authorization مع كل طلب:

Authorization: Bearer skyd_...

• تبدأ الرموز بـ skyd_.
• لكل مستخدم رمز صالح واحد على الأكثر. الرمز الجديد يُبطل الرمز القديم.
• انقر إبطال الرمز لإيقاف رمز.

المرجع التفاعلي

المرجع الكامل موجود في api.skynetml.com/scalar. يسرد كل نقطة نهاية عامة وحقولها واستجاباتها. يمكنك إرسال طلبات تجريبية من تلك الصفحة.

يقرأ المرجع مستند OpenAPI الموجود في https://api.skynetml.com/openapi.public.json. استخدم هذا الملف لتوليد عميل بلغتك.

نقاط النهاية الرئيسية

بدء تشغيل

تأخذ POST /optimize الإعداد نفسه الذي يأخذه معالج الإرسال. يحسّن هذا المثال موجّهًا يصنّف رسائل الدعم إلى تسميات.

curl https://api.skynetml.com/optimize \
  -H "Authorization: Bearer $SKYNET_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: support-labels-001" \
  -d @run.json

{
  "name": "Support labels",
  "task": {
    "objective": "Sort each support message into billing, bug or other.",
    "artifact": {
      "kind": "prompt",
      "starting_version": "Label this support message as billing, bug or other."
    }
  },
  "data": {
    "mode": "pairs",
    "cases": [
      { "input": { "message": "I was charged twice." }, "expected": { "label": "billing" } },
      { "input": { "message": "The export button does nothing." }, "expected": { "label": "bug" } },
      {
        "input": { "message": "Do you have a Hebrew interface?" },
        "expected": { "label": "other" }
      }
    ]
  },
  "optimizer": { "choice": "auto", "budget": { "max_scorer_runs": 200 } },
  "models": {
    "task_model": { "name": "<model from GET /models>" },
    "reflection_model": { "name": "<model from GET /models>" }
  },
  "workspace": {
    "run_code": "from skynet import llm\n\ndef run(artifact, input):\n    return llm(artifact, input=input[\"message\"])\n",
    "metric_code": "def score(input, output, expected=None):\n    ok = str(output).strip().lower() == expected[\"label\"]\n    return (1.0 if ok else 0.0), {\"feedback\": \"Correct.\" if ok else \"Wrong label.\"}\n"
  },
  "max_cost_cents": 500
}

حقول مهمة:

• قيمة task.artifact.kind هي prompt أو code أو text أو dspy_program.
• قيمة data.mode هي pairs (مُدخلات مع مخرجات متوقعة) أو single (حالة واحدة بالضبط).
• قيمة optimizer.choice هي auto أو اسم مُحسِّن واحد من GET /optimizers.
• الحقل max_cost_cents هو حد الإنفاق لهذا التشغيل، بالسنت الأمريكي.
• قيمة is_private الافتراضية هي false. اضبطها على true لإبقاء التشغيل خاصًا.

اقرأ المقاييس والمُقيِّمات لمعرفة قواعد run_code وmetric_code.

الاستجابات

متابعة تشغيل

استعلم عن التشغيل دوريًا حتى تصبح حالته نهائية:

curl https://api.skynetml.com/optimizations/$RUN_ID \
  -H "Authorization: Bearer $SKYNET_TOKEN"

قيمة الحقل status واحدة مما يلي:

استعلم كل 10 إلى 30 ثانية. قد يستغرق التشغيل من دقائق إلى ساعات.

يسرد مرجع API كل حقل في استجابة التشغيل.

استخدام النتيجة

عندما تكون الحالة success، احصل على أفضل نسخة:

curl https://api.skynetml.com/optimizations/$RUN_ID/artifact \
  -H "Authorization: Bearer $SKYNET_TOKEN"

لتشغيل أفضل نسخة على إدخال جديد، أرسل POST /serve/{optimization_id}. اقرأ النتائج لتعرف معنى كل درجة.

الحدود

تستخدم الواجهة حصص الاستخدام وحدود المعدّل والفوترة نفسها التي يستخدمها تطبيق الويب. اقرأ الحدود والفوترة.