Felo API PlatformFelo API Platform
v0.4.0
OpenAPI 3.1.0

Eine Bildgenerierungsaufgabe einreichen

Felo API Support
MIT
Server:https://openapi.felo.ai
Client-Bibliotheken
Shell Curl

Eine Bildgenerierungsaufgabe einreichen

​

Gibt HTTP 202 mit einer dauerhaften task_id zurück. Fragen Sie GET /api/v1/images/generations/{task_id} ab. Flache oder verschachtelte Eingaben werden unterstützt; verschachtelte Eingaben haben Vorrang. Callback-Felder werden ignoriert. Funktionen und Eingabeparameter hängen vom konfigurierten Modell und Kanal ab.

Header
  • X-Request-Id
    Typ: string

    Optionale Anfrage-ID des Aufrufers, die zu Diagnosezwecken zurückgegeben wird.

  • X-Felo-Channel
    Typ: string

    Geordnete, durch Kommas getrennte öffentliche Kanalcodes. Lassen Sie diesen Header weg, um default zu verwenden; default muss allein verwendet werden. Im Wallet-Modus durchsucht default die effektive öffentliche Kanalreihenfolge des Modells in umgekehrter Reihenfolge, überspringt nicht veröffentlichte oder nicht verfügbare Kanäle und wählt den Anbieter des ersten verfügbaren Kanals. Der Wert default schließt verfügbare Endpunkte dieses Anbieters mit derselben Upstream-Modell-ID und demselben Service-Tier ein. Explizite Kanäle werden in der vom Client angegebenen Reihenfolge validiert; nur die Anbietergruppe des ersten Kanals wird übermittelt. Kein automatischer Fallback auf andere Anbieter. Legacy-Anbieter-Header können das Kanal-Routing nicht überschreiben.

Body·ImageGenerationRequest
erforderlich
application/json

Modellspezifische Eingaben folgen dem konfigurierten öffentlichen Modellprotokoll.

  • model
    Typ: string
    erforderlich
  • image_urls
    Typ: array string[]
  • input
    Typ: object

    Optionale verschachtelte Eingabe; hat Vorrang vor der flachen Eingabe.

    • service_tier
      Typ: string | null

      Derzeit wird nur default (standard) unterstützt. Weggelassene Werte, null, Aliase und nicht unterstützte Zeichenfolgen fallen auf default zurück; andere Typen liefern HTTP 400. Konfigurierte Kanäle und Preise bleiben unverändert. Text-APIs senden den Standardwert des Anbieters; Decisions- und Generierungs-APIs lassen das Upstream-Feld weg.

    • propertyName
      Typ: anything
  • n
    Typ: integer

    Integer numbers.

  • prompt
    Typ: string
  • service_tier
    Typ: string | null

    Derzeit wird nur default (standard) unterstützt. Weggelassene Werte, null, Aliase und nicht unterstützte Zeichenfolgen fallen auf default zurück; andere Typen liefern HTTP 400. Konfigurierte Kanäle und Preise bleiben unverändert. Text-APIs senden den Standardwert des Anbieters; Decisions- und Generierungs-APIs lassen das Upstream-Feld weg.

  • size
    Typ: string
  • propertyName
    Typ: anything
Antworten
  • 202
    Typ: object · ImageGenerationAccepted

    Aufgabe angenommen

    • kind
      enum
      Konstante:  
      image
      erforderlich
      Werte
      • image
    • outputs
      Typ: array string[]
      erforderlich

      Leer, bis die Aufgabe erfolgreich ist.

    • status
      enum
      Konstante:  
      queued
      erforderlich
      Werte
      • queued
    • task_id
      Typ: string
      erforderlich

      Aufgaben-ID für die Statusabfrage.

    application/json
  • 400
    Typ: object · GenerationError

    Ungültige Anfrage (unbekanntes Modell, gemischte Eingabemodi, ungültige Felder)

    OpenAI-kompatibles Fehler-Envelope.

    • error
      Typ: object
      • message
        Typ: string
        erforderlich
      • type
        Typ: string enum
        erforderlich
        Werte
        • invalid_request_error
        • server_error
      • code
        Typ: string
      • param
        Typ: string nullable
    application/json
  • 401
    Typ: object · GenerationError

    Ungültiger oder fehlender Felo-API-Schlüssel

    OpenAI-kompatibles Fehler-Envelope.

    • error
      Typ: object
      • message
        Typ: string
        erforderlich
      • type
        Typ: string enum
        erforderlich
        Werte
        • invalid_request_error
        • server_error
      • code
        Typ: string
      • param
        Typ: string nullable
    application/json
  • 402
    Typ: object · GenerationError

    Unzureichendes Guthaben / Abrechnungsvoraussetzung nicht erfüllt

    OpenAI-kompatibles Fehler-Envelope.

    • error
      Typ: object
      • message
        Typ: string
        erforderlich
      • type
        Typ: string enum
        erforderlich
        Werte
        • invalid_request_error
        • server_error
      • code
        Typ: string
      • param
        Typ: string nullable
    application/json
  • 403
    Typ: object · GenerationError

    Konto nicht berechtigt (Abonnement erforderlich oder Benutzer gesperrt). Deaktivierte Modelle werden ebenfalls vor Upstream-Aufrufen abgelehnt. Bereits angenommene Anfragen und Aufgaben werden fortgesetzt.

    OpenAI-kompatibles Fehler-Envelope.

    • error
      Typ: object
      • message
        Typ: string
        erforderlich
      • type
        Typ: string enum
        erforderlich
        Werte
        • invalid_request_error
        • server_error
      • code
        Typ: string
      • param
        Typ: string nullable
    application/json
  • 429
    Typ: object · GenerationError

    Anfrage- oder Ausgabenlimit erreicht

    OpenAI-kompatibles Fehler-Envelope.

    • error
      Typ: object
      • message
        Typ: string
        erforderlich
      • type
        Typ: string enum
        erforderlich
        Werte
        • invalid_request_error
        • server_error
      • code
        Typ: string
      • param
        Typ: string nullable
    application/json
  • 502
    Typ: object · GenerationError

    Upstream-Anbieter fehlgeschlagen

    OpenAI-kompatibles Fehler-Envelope.

    • error
      Typ: object
      • message
        Typ: string
        erforderlich
      • type
        Typ: string enum
        erforderlich
        Werte
        • invalid_request_error
        • server_error
      • code
        Typ: string
      • param
        Typ: string nullable
    application/json
  • 503
    Typ: object · GenerationError

    Generierungsdienst oder Abrechnungsdienst vorübergehend nicht verfügbar

    OpenAI-kompatibles Fehler-Envelope.

    • error
      Typ: object
      • message
        Typ: string
        erforderlich
      • type
        Typ: string enum
        erforderlich
        Werte
        • invalid_request_error
        • server_error
      • code
        Typ: string
      • param
        Typ: string nullable
    application/json
Request Example for post/api/v1/images/generations
curl https://openapi.felo.ai/api/v1/images/generations \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "model": "configured-image-model",
  "prompt": "a cat"
}'

{
  "task_id": "string",
  "status": "queued",
  "kind": "image",
  "outputs": [
    "string"
  ]
}

Aufgabe angenommen

Submit an image generation task