Armox
    Armox Academy 📚
    API-ReferenzEinführung in die API-Referenz

    API-Referenz Einführung

    Die öffentliche Armox-API ermöglicht berechtigten Abonnenten, 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 für folgende Pläne verfügbar:

    • Agency
    • Master / Business
    • Enterprise

    Für Free/Pro-Pläne ist kein Zugang zur öffentlichen API verfügbar.

    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


    Schnellstart in 5 Schritten

    1. Erstellen Sie einen API-Schlüssel unter /app/settings/api-keys
    2. Rufen Sie GET /api/v1/models auf, um gültige Modell-IDs und Einstellungen zu entdecken
    3. Führen Sie ein Modell aus mit POST /api/v1/models/run
    4. Falls die Antwort asynchron ist (status: "processing"), pollen Sie GET /api/v1/jobs/:id
    5. Optional: Fügen Sie webhook_url hinzu, um Abschluss-Events zu empfangen

    Ihre erste Anfrage

    cURL

    Prompt Template
    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)

    Prompt Template
    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

    Prompt Template
    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

    Prompt Template
    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

    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.id in Ihrer Datenbank
    • Pollen Sie entweder /jobs/:id oder verarbeiten Sie Webhook-Events
    • Speichern Sie die resultierenden Ausgabe-URLs für Ihre App-Oberfläche

    Bereit, deinen kreativen Workflow zu transformieren?

    Keine Kreditkarte erforderlich2000 kostenlose Credits