Felo API PlatformFelo API Platform
v0.4.0
OpenAPI 3.1.0

Inviare un'attività di generazione immagini

Felo API Support
MIT
Server:https://openapi.felo.ai
Librerie client
Shell Curl

Inviare un'attività di generazione immagini

​

Restituisce HTTP 202 con un task_id persistente. Eseguire il polling di GET /api/v1/images/generations/{task_id}. Sono supportati input piatto o annidato; l'input annidato ha la precedenza. I campi callback vengono ignorati. Le capacità e i parametri di input dipendono dal modello e dal canale configurati.

Intestazioni
  • X-Request-Id
    Tipo: string

    ID richiesta del chiamante facoltativo, restituito per diagnostica.

  • X-Felo-Channel
    Tipo: string

    Codici canale pubblici separati da virgola e in ordine. Omettere questa intestazione per usare default; default deve essere usato da solo. In modalità wallet, default analizza in ordine inverso l'ordine effettivo dei canali pubblici del modello, ignora i canali non pubblicati o non disponibili e seleziona il provider del primo canale disponibile. Include gli endpoint disponibili di quel provider con lo stesso ID modello upstream e lo stesso livello di servizio. I canali espliciti vengono convalidati nell'ordine indicato dal client; viene inviato solo il gruppo di provider del primo canale. Nessun fallback automatico ad altri provider. Le intestazioni dei provider legacy non possono ignorare l'instradamento dei canali.

Corpo·ImageGenerationRequest
obbligatorio
application/json

L'input specifico del modello segue il protocollo pubblico del modello configurato.

  • model
    Tipo: string
    obbligatorio
  • image_urls
    Tipo: array string[]
  • input
    Tipo: object

    Input annidato facoltativo; ha la precedenza sull'input piatto.

    • service_tier
      Tipo: string | null

      Attualmente è supportato solo default (standard). Se omesso, null, alias e stringhe non supportate ricadono su default; altri tipi restituiscono HTTP 400. I canali e i prezzi configurati restano invariati. Le API di testo inviano il valore standard del provider; le API Decisions e di generazione omettono il campo upstream.

    • propertyName
      Tipo: anything
  • n
    Tipo: integer

    Integer numbers.

  • prompt
    Tipo: string
  • service_tier
    Tipo: string | null

    Attualmente è supportato solo default (standard). Se omesso, null, alias e stringhe non supportate ricadono su default; altri tipi restituiscono HTTP 400. I canali e i prezzi configurati restano invariati. Le API di testo inviano il valore standard del provider; le API Decisions e di generazione omettono il campo upstream.

  • size
    Tipo: string
  • propertyName
    Tipo: anything
Risposte
  • 202
    Tipo: object · ImageGenerationAccepted

    Attività accettata

    • kind
      enum
      const:  
      image
      obbligatorio
      valori
      • image
    • outputs
      Tipo: array string[]
      obbligatorio

      Vuoto finché l'attività non viene completata con successo.

    • status
      enum
      const:  
      queued
      obbligatorio
      valori
      • queued
    • task_id
      Tipo: string
      obbligatorio

      ID attività da usare per il polling.

    application/json
  • 400
    Tipo: object · GenerationError

    Richiesta non valida (modello sconosciuto, modalità di input miste, campi non validi)

    Struttura di errore compatibile con OpenAI.

    • error
      Tipo: object
      • message
        Tipo: string
        obbligatorio
      • type
        Tipo: string enum
        obbligatorio
        valori
        • invalid_request_error
        • server_error
      • code
        Tipo: string
      • param
        Tipo: string ammette null
    application/json
  • 401
    Tipo: object · GenerationError

    Chiave API Felo non valida o mancante

    Struttura di errore compatibile con OpenAI.

    • error
      Tipo: object
      • message
        Tipo: string
        obbligatorio
      • type
        Tipo: string enum
        obbligatorio
        valori
        • invalid_request_error
        • server_error
      • code
        Tipo: string
      • param
        Tipo: string ammette null
    application/json
  • 402
    Tipo: object · GenerationError

    Saldo insufficiente / requisito di fatturazione non soddisfatto

    Struttura di errore compatibile con OpenAI.

    • error
      Tipo: object
      • message
        Tipo: string
        obbligatorio
      • type
        Tipo: string enum
        obbligatorio
        valori
        • invalid_request_error
        • server_error
      • code
        Tipo: string
      • param
        Tipo: string ammette null
    application/json
  • 403
    Tipo: object · GenerationError

    Account non autorizzato (abbonamento richiesto o utente bloccato). Anche i modelli disattivati vengono rifiutati prima delle chiamate upstream. Le richieste e le attività già accettate proseguono.

    Struttura di errore compatibile con OpenAI.

    • error
      Tipo: object
      • message
        Tipo: string
        obbligatorio
      • type
        Tipo: string enum
        obbligatorio
        valori
        • invalid_request_error
        • server_error
      • code
        Tipo: string
      • param
        Tipo: string ammette null
    application/json
  • 429
    Tipo: object · GenerationError

    Limite di richieste o di spesa raggiunto

    Struttura di errore compatibile con OpenAI.

    • error
      Tipo: object
      • message
        Tipo: string
        obbligatorio
      • type
        Tipo: string enum
        obbligatorio
        valori
        • invalid_request_error
        • server_error
      • code
        Tipo: string
      • param
        Tipo: string ammette null
    application/json
  • 502
    Tipo: object · GenerationError

    Errore del provider upstream

    Struttura di errore compatibile con OpenAI.

    • error
      Tipo: object
      • message
        Tipo: string
        obbligatorio
      • type
        Tipo: string enum
        obbligatorio
        valori
        • invalid_request_error
        • server_error
      • code
        Tipo: string
      • param
        Tipo: string ammette null
    application/json
  • 503
    Tipo: object · GenerationError

    Servizio di generazione o servizio di fatturazione temporaneamente non disponibile

    Struttura di errore compatibile con OpenAI.

    • error
      Tipo: object
      • message
        Tipo: string
        obbligatorio
      • type
        Tipo: string enum
        obbligatorio
        valori
        • invalid_request_error
        • server_error
      • code
        Tipo: string
      • param
        Tipo: string ammette null
    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"
  ]
}

Attività accettata

Submit an image generation task