nebula@atheron:/de/docs$
// Dokumentation
Eine API für alles
REST, JSON und ein Webhook.
Senden Sie einen Stapel, verfolgen Sie ihn und laden Sie das Ergebnis herunter. Die vollständige Referenz liegt im Entwicklerportal, neben Ihren Schlüsseln.
Schlüssel
Erstellen Sie Schlüssel im Entwicklerportal, sobald Ihr Team die Unternehmensprüfung bestanden und eine Karte hinterlegt hat. Senden Sie einen Schlüssel als Bearer-Token.
- Testschlüssel beginnen mit ath_test_, verarbeiten bis zu 100 Elemente pro Batch auf Atherons eigenen Rechnern und belasten nie Ihre Karte
- Live-Schlüssel beginnen mit ath_live_ und führen echte Aufträge aus
- Ein Schlüssel braucht das Recht nebula, um Aufträge zu senden
- Schlüssel werden einmal angezeigt und nur als Hash gespeichert
Webhooks
Wenn ein Stapel fertig ist, senden wir batch.completed an Ihre Webhook-Adresse, signiert, damit Sie prüfen können, dass es von uns kommt. Eine fehlgeschlagene Zustellung wird 3 Tage lang wiederholt.
In der vollständigen Referenz
- Schnellstart
- Aufgaben und Modelle
- Eingabeformate
- Ergebnisse und Aufbewahrung
- Teilbare und private Aufträge
- Feinabstimmungsaufträge
- Webhooks und Signaturen
- Fehler und Grenzen
- Nutzung und Abrechnung
Endpunkte
Jede Anfrage und jede Antwort ist JSON.
POST /api/v1/nebula/batchesEinen Stapel senden: die Aufgabe, das Modell, Ihre Elemente, ob er teilbar ist, und eine Webhook-Adresse.
GET /api/v1/nebula/batches/{id}Der Zustand eines Stapels und wie viele Teile fertig sind.
GET /api/v1/nebula/batches/{id}/resultsEin kurzlebiger Link zur Ergebnisdatei, sobald der Stapel fertig ist.
POST /api/v1/nebula/batches/{id}/cancelEinen Stapel anhalten. Fertige Teile bleiben erhalten und werden berechnet.
GET /api/v1/nebula/modelsDer Modellkatalog, mit Aufgabe, Lizenz und Grenzen jedes Modells.
Beispiel
curl https://developers.aton-network.org/api/v1/nebula/batches \
-H "Authorization: Bearer $ATHERON_KEY" \
-H "Content-Type: application/json" \
-d '{
"task": "embed",
"model": "bge-base-en-v1.5",
"shareable": false,
"items": [
{ "id": "doc-1", "text": "Machine learning on a shared network." },
{ "id": "doc-2", "text": "Every result is checked twice." }
],
"webhook": "https://example.com/hooks/nebula"
}'curl https://developers.aton-network.org/api/v1/nebula/batches/bat_123 \
-H "Authorization: Bearer $ATHERON_KEY"
{ "id": "bat_123", "state": "running", "shards": { "done": 12, "total": 40 } }Eine Frage, die die Doku nicht beantwortet? Sprechen Sie mit unserem Team.