Zum Inhalt springen
Seiten

Integrationen

API

Authentifizieren, einen Durchlauf starten und Ergebnisse über die HTTP-API lesen.

Mit der Skynet-HTTP-API können Skripte und Werkzeuge dasselbe tun wie die Web-App: Durchläufe starten, sie beobachten und die Ergebnisse lesen. Diese Seite zeigt, wie Sie Anfragen authentifizieren, wo die vollständige Referenz liegt, und ein vollständiges Beispiel.

Basis-URL

Senden Sie jede Anfrage an:

https://api.skynetml.com

Authentifizierung

Die API verwendet API-Tokens.

  1. Öffnen Sie in Skynet Einstellungen und dann den Tab API.
  2. Klicken Sie auf Token generieren.
  3. Kopieren Sie das Token sofort. Skynet zeigt das vollständige Token nur einmal.

Senden Sie das Token im Header Authorization jeder Anfrage:

Authorization: Bearer skyd_...
  • Tokens beginnen mit skyd_.
  • Jeder Nutzer hat höchstens ein gültiges Token. Ein neues Token macht das alte Token ungültig.
  • Klicken Sie auf Token widerrufen, um ein Token ungültig zu machen.

Interaktive Referenz

Die vollständige Referenz finden Sie unter api.skynetml.com/scalar. Sie listet jeden öffentlichen Endpunkt mit seinen Feldern und Antworten auf. Von dieser Seite aus können Sie Testanfragen senden.

Die Referenz liest das OpenAPI-Dokument unter https://api.skynetml.com/openapi.public.json. Mit dieser Datei können Sie einen Client in Ihrer Programmiersprache generieren.

Wichtige Endpunkte

Methode und PfadWas er tut
GET /modelsListet die Modelle auf, die Sie verwenden können.
GET /optimizersListet die Optimierer auf, die zu einer Konfiguration passen.
GET /blackbox/enginesListet die nativen Engines auf und ob jede verfügbar ist.
POST /optimizeStartet einen Durchlauf für einen Prompt, Code, Text oder ein DSPy-Programm.
POST /blackbox/runStartet einen Durchlauf auf einem GitHub-Repository.
GET /optimizationsListet Ihre Durchläufe auf.
GET /optimizations/{optimization_id}Gibt einen Durchlauf zurück: Status, Fortschritt, Logs und Ergebnis.
GET /optimizations/{optimization_id}/artifactGibt die beste Version zurück, die der Durchlauf gefunden hat.
POST /optimizations/{optimization_id}/cancelStoppt einen Durchlauf.
POST /serve/{optimization_id}Führt die beste Version mit einer neuen Eingabe aus.
GET /healthZeigt, ob der Dienst läuft.

Einen Durchlauf starten

POST /optimize nimmt dieselbe Konfiguration an wie der Einreichungsassistent. Dieses Beispiel verbessert einen Prompt, der Support-Nachrichten Labels zuordnet.

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

Wichtige Felder:

  • task.artifact.kind ist prompt, code, text oder dspy_program.
  • data.mode ist pairs (Eingaben mit erwarteten Ausgaben) oder single (genau ein Fall).
  • optimizer.choice ist auto oder ein Optimierername aus GET /optimizers.
  • max_cost_cents ist das Ausgabenlimit für diesen Durchlauf, in US-Cent.
  • is_private ist standardmäßig false. Setzen Sie es auf true, um den Durchlauf privat zu halten.

Die Regeln für run_code und metric_code lesen Sie unter Metriken und Scorer.

Antworten

StatusBedeutung
201Skynet hat den Durchlauf in die Warteschlange gestellt. Der Body enthält optimization_id und status.
202Die Konfigurationsprüfung läuft noch. Warten Sie die Sekunden aus dem Header Retry-After ab. Senden Sie dann denselben Body mit demselben Idempotency-Key.
402Ihr Guthaben ist zu niedrig.
409Sie haben ein Kontingent erreicht, oder die Konfigurationsprüfung ist veraltet.
422Die Anfrage oder der Workspace-Code passt nicht zum Optimierer.

Einen Durchlauf beobachten

Fragen Sie den Durchlauf ab, bis sein Status endgültig ist:

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

Das Feld status hat einen dieser Werte:

StatusEndgültig
pending, validating, runningNein
pausedNein
successJa
failed, cancelled, stoppedJa

Fragen Sie alle 10 bis 30 Sekunden ab. Ein Durchlauf kann Minuten bis Stunden dauern.

Die API-Referenz listet jedes Feld der Durchlaufantwort auf.

Das Ergebnis verwenden

Lautet der Status success, rufen Sie die beste Version ab:

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

Um die beste Version mit einer neuen Eingabe auszuführen, senden Sie POST /serve/{optimization_id}. Was jeder Score bedeutet, lesen Sie unter Ergebnisse lesen.

Limits

Die API verwendet dieselben Kontingente, Ratenlimits und dieselbe Abrechnung wie die Web-App. Lesen Sie Limits und Abrechnung.