API-Referenz Einführung
Die öffentliche Armox-API ermöglicht allen Nutzern, dieselben Modelle und App-Workflows auszuführen, die Armox Canvas antreiben – direkt aus Ihrem Backend, Ihren Automatisierungen und internen Tools.
Nutzen Sie diese Seite als Ausgangspunkt und besuchen Sie anschließend die jeweiligen Endpunkt-Seiten für vollständige Request-/Response-Referenzen und Produktionsmuster.
Wer kann diese API nutzen
Der Zugang zur öffentlichen API ist in allen Plänen verfügbar, einschließlich Free, Hobby, Pro, Ultra, der bisherigen Pläne Agency und Master, Business und Enterprise. Ein gültiger API-Schlüssel ist erforderlich. Generierungen nutzen die Credits und Limits Ihres Plans.
Basis-URL
Verwenden Sie die Armox-Produktions-API-Basis-URL für alle Endpunkte:
https://armox.ai/api/v1
Authentifizierung
Alle API-Endpunkte erfordern einen Bearer-API-Schlüssel im Authorization-Header:
curl -X GET "https://armox.ai/api/v1/models" \
-H "Authorization: Bearer sk_live_your_key_here"
Schlüssel verwalten Sie unter:
https://armox.ai/app/settings/api-keys
Für die vollständige Schlüsselverwaltung und Sicherheitspraktiken siehe:
API-Abschnitte
- Authentifizierung
- Models-Endpunkt
- Apps-Endpunkt
- Jobs-Endpunkt
- Account-Endpunkt
- Webhooks
- Fehler & Rate Limits
Schnellstart in 5 Schritten
- Erstellen Sie einen API-Schlüssel unter
/app/settings/api-keys - Rufen Sie
GET /api/v1/modelsauf, um gültige Modell-IDs und Einstellungen zu entdecken - Führen Sie ein Modell aus mit
POST /api/v1/models/run - Falls die Antwort asynchron ist (
status: "processing"), pollen SieGET /api/v1/jobs/:id - Optional: Fügen Sie
webhook_urlhinzu, um Abschluss-Events zu empfangen
Ihre erste Anfrage
cURL
curl -X POST "https://armox.ai/api/v1/models/run" \ -H "Authorization: Bearer sk_live_your_key_here" \ -H "Content-Type: application/json" \ -d '{ "model": "google/nano-banana", "input": { "prompt": "Turn this into a cinematic night street photo with neon signs and reflections.", "image_input": ["https://example.com/reference-image.jpg"], "aspect_ratio": "match_input_image", "output_format": "png" } }'
JavaScript (fetch)
const response = await fetch("https://armox.ai/api/v1/models/run", { method: "POST", headers: { Authorization: "Bearer sk_live_your_key_here", "Content-Type": "application/json", }, body: JSON.stringify({ model: "google/nano-banana", input: { prompt: "Turn this into a cinematic night street photo with neon signs and reflections.", image_input: ["https://example.com/reference-image.jpg"], aspect_ratio: "match_input_image", output_format: "png", }, }), }); const data = await response.json(); console.log(data);
Python
import requests response = requests.post( "https://armox.ai/api/v1/models/run", headers={ "Authorization": "Bearer sk_live_your_key_here", "Content-Type": "application/json", }, json={ "model": "google/nano-banana", "input": { "prompt": "Turn this into a cinematic night street photo with neon signs and reflections.", "image_input": ["https://example.com/reference-image.jpg"], "aspect_ratio": "match_input_image", "output_format": "png", }, }, ) print(response.status_code) print(response.json())
Go
package main import ( "bytes" "encoding/json" "fmt" "net/http" ) func main() { payload := map[string]any{ "model": "google/nano-banana", "input": map[string]any{ "prompt": "Turn this into a cinematic night street photo with neon signs and reflections.", "image_input": []string{"https://example.com/reference-image.jpg"}, "aspect_ratio": "match_input_image", "output_format": "png", }, } b, _ := json.Marshal(payload) req, _ := http.NewRequest("POST", "https://armox.ai/api/v1/models/run", bytes.NewBuffer(b)) req.Header.Set("Authorization", "Bearer sk_live_your_key_here") req.Header.Set("Content-Type", "application/json") client := &http.Client{} resp, _ := client.Do(req) defer resp.Body.Close() fmt.Println("Status:", resp.StatusCode) }
Häufige nächste Schritte
- Authentifizierung und Schlüsselsicherheit lernen: Authentifizierung
- Synchrone/asynchrone Modellausführungen verstehen: Models-Endpunkt
- App-Workflow-Automatisierungen erstellen: Apps-Endpunkt
- Polling und Stornierung implementieren: Jobs-Endpunkt
- Produktions-Webhooks konfigurieren: Webhooks
- Fehler und 429-Wiederholungen behandeln: Fehler & Rate Limits
Sicherheitsgrundlagen
- API-Schlüssel nur serverseitig verwenden
- Schlüssel regelmäßig rotieren
- Separate Schlüssel für Entwicklung/Staging/Produktion verwenden
- Webhook-Signaturen vor der Verarbeitung von Payloads überprüfen
Produktionshinweise
- Speichern Sie die zurückgegebene
job.idin Ihrer Datenbank - Pollen Sie entweder
/jobs/:idoder verarbeiten Sie Webhook-Events - Speichern Sie die resultierenden Ausgabe-URLs für Ihre App-Oberfläche