API

HTTP API در Skynet به اسکریپت‌ها و ابزارها اجازه می‌دهد همان کارهای اپلیکیشن وب را انجام دهند: اجراها را شروع کنند، آن‌ها را پیگیری کنند و نتیجه‌ها را بخوانند. این صفحه نشان می‌دهد درخواست‌ها را چگونه امضا کنید، مرجع کامل کجاست، و یک مثال کامل می‌آورد.

نشانی پایه

همهٔ درخواست‌ها را به این نشانی بفرستید:

https://api.skynetml.com

احراز هویت

API از توکن‌های API استفاده می‌کند.

1. در Skynet، تنظیمات را باز کنید، سپس زبانهٔ API را باز کنید.
2. روی تولید توکن کلیک کنید.
3. توکن را فوراً کپی کنید. Skynet توکن کامل را فقط یک بار نشان می‌دهد.

توکن را در سرآیند Authorization هر درخواست بفرستید:

Authorization: Bearer skyd_...

• توکن‌ها با skyd_ شروع می‌شوند.
• هر کاربر حداکثر یک توکن معتبر دارد. یک توکن جدید توکن قبلی را از کار می‌اندازد.
• برای از کار انداختن یک توکن، روی ابطال توکن کلیک کنید.

مرجع تعاملی

مرجع کامل در api.skynetml.com/scalar است. این مرجع هر نقطهٔ پایانی (endpoint) عمومی، فیلدها و پاسخ‌های آن را فهرست می‌کند. می‌توانید از همان صفحه درخواست‌های آزمایشی بفرستید.

مرجع سند 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، معیارها و امتیازدهنده‌ها را بخوانید.

پاسخ‌ها

پیگیری یک اجرا

اجرا را تا وقتی وضعیتش نهایی شود، به‌طور دوره‌ای بپرسید (poll):

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

فیلد status یکی از این مقدارهاست:

هر ۱۰ تا ۳۰ ثانیه یک بار بپرسید. یک اجرا ممکن است از چند دقیقه تا چند ساعت طول بکشد.

مرجع API همهٔ فیلدهای پاسخ اجرا را فهرست می‌کند.

استفاده از نتیجه

وقتی وضعیت success است، بهترین نسخه را بگیرید:

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

برای اجرای بهترین نسخه روی یک ورودی جدید، POST /serve/{optimization_id} را بفرستید. برای معنی هر امتیاز، نتیجه‌ها را بخوانید.

محدودیت‌ها

API از همان سهمیه‌ها، محدودیت‌های نرخ درخواست و صورت‌حسابِ اپلیکیشن وب استفاده می‌کند. محدودیت‌ها و صورت‌حساب را بخوانید.