İçeriğe atla
Sayfalar

Entegrasyonlar

API

HTTP API ile kimlik doğrulayın, çalıştırma başlatın ve sonuçları okuyun.

Skynet HTTP API'si, betiklerin ve araçların web uygulamasının yaptığı işleri yapmasını sağlar: çalıştırma başlatmak, çalıştırmaları izlemek ve sonuçları okumak. Bu sayfa isteklerin nasıl imzalanacağını, tam başvuru belgesinin nerede olduğunu ve eksiksiz bir örneği gösterir.

Temel URL

Her isteği şu adrese gönderin:

https://api.skynetml.com

Kimlik doğrulama

API, API belirteçlerini kullanır.

  1. Skynet'te Ayarlar'ı, ardından API sekmesini açın.
  2. Belirteç oluştur'a tıklayın.
  3. Belirteci hemen kopyalayın. Skynet tam belirteci yalnızca bir kez gösterir.

Belirteci her isteğin Authorization başlığında gönderin:

Authorization: Bearer skyd_...
  • Belirteçler skyd_ ile başlar.
  • Her kullanıcının en fazla bir geçerli belirteci olur. Yeni bir belirteç eski belirteci devre dışı bırakır.
  • Bir belirteci devre dışı bırakmak için Belirteci iptal et'e tıklayın.

Etkileşimli başvuru

Tam başvuru belgesi api.skynetml.com/scalar adresindedir. Her genel uç noktayı, alanlarını ve yanıtlarını listeler. Bu sayfadan test istekleri gönderebilirsiniz.

Başvuru belgesi https://api.skynetml.com/openapi.public.json adresindeki OpenAPI belgesini okur. Kendi dilinizde bir istemci oluşturmak için bu dosyayı kullanın.

Ana uç noktalar

Yöntem ve yolNe yapar
GET /modelsKullanabileceğiniz modelleri listeler.
GET /optimizersBir kuruluma uyan optimize edicileri listeler.
GET /blackbox/enginesYerel motorları ve her birinin kullanılabilir olup olmadığını listeler.
POST /optimizeBir istem, kod, metin veya DSPy programı için çalıştırma başlatır.
POST /blackbox/runBir GitHub deposu üzerinde çalıştırma başlatır.
GET /optimizationsÇalıştırmalarınızı listeler.
GET /optimizations/{optimization_id}Tek bir çalıştırmayı döndürür: durum, ilerleme, günlükler ve sonuç.
GET /optimizations/{optimization_id}/artifactÇalıştırmanın bulduğu en iyi sürümü döndürür.
POST /optimizations/{optimization_id}/cancelBir çalıştırmayı durdurur.
POST /serve/{optimization_id}En iyi sürümü yeni bir girdi üzerinde çalıştırır.
GET /healthHizmetin çalışıp çalışmadığını gösterir.

Bir çalıştırma başlatma

POST /optimize, gönderme sihirbazıyla aynı kurulumu alır. Bu örnek, destek mesajlarını etiketlere ayıran bir istemi iyileştirir.

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

Önemli alanlar:

  • task.artifact.kind değeri prompt, code, text veya dspy_program'dır.
  • data.mode değeri pairs (beklenen çıktılarla birlikte girdiler) veya single'dır (tam olarak bir vaka).
  • optimizer.choice değeri auto veya GET /optimizers tarafından döndürülen bir optimize edici adıdır.
  • max_cost_cents, bu çalıştırmanın ABD senti cinsinden harcama limitidir.
  • is_private varsayılan olarak false'tur. Çalıştırmayı özel tutmak için true olarak ayarlayın.

run_code ve metric_code kuralları için Metrikler ve puanlayıcılar sayfasını okuyun.

Yanıtlar

DurumAnlamı
201Skynet çalıştırmayı kuyruğa aldı. Gövde optimization_id ve status içerir.
202Kurulum kontrolü hâlâ çalışıyor. Retry-After başlığındaki saniye kadar bekleyin. Ardından aynı gövdeyi aynı Idempotency-Key ile gönderin.
402Bakiyeniz çok düşük.
409Bir kotaya ulaştınız veya kurulum kontrolü güncel değil.
422İstek veya çalışma alanı kodu optimize ediciye uymuyor.

Bir çalıştırmayı izleme

Durumu nihai olana kadar çalıştırmayı sorgulayın:

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

status alanı şunlardan biridir:

DurumNihai
pending, validating, runningHayır
pausedHayır
successEvet
failed, cancelled, stoppedEvet

10 ila 30 saniyede bir sorgulayın. Bir çalıştırma dakikalardan saatlere kadar sürebilir.

API başvurusu, çalıştırma yanıtının her alanını listeler.

Sonucu kullanma

Durum success olduğunda en iyi sürümü alın:

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

En iyi sürümü yeni bir girdi üzerinde çalıştırmak için POST /serve/{optimization_id} gönderin. Her puanın ne anlama geldiği için Sonuçlar sayfasını okuyun.

Limitler

API, web uygulamasıyla aynı kotaları, hız limitlerini ve faturalandırmayı kullanır. Limitler ve Faturalandırma sayfalarını okuyun.