API

HTTP API Skynet дає змогу скриптам та інструментам робити те саме, що й вебзастосунок: запускати оптимізації, стежити за ними й читати результати. Ця сторінка показує, як підписувати запити, де знайти повний довідник, і містить один повний приклад.

Базова URL-адреса

Надсилайте кожен запит на:

https://api.skynetml.com

Автентифікація

API використовує 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}. Що означає кожна оцінка, описано в розділі Читання результатів.

Ліміти

API використовує ті самі квоти, обмеження частоти запитів і тарифікацію, що й вебзастосунок. Прочитайте Ліміти і Бюджети й оплата.