Felo API PlatformFelo API Platform
v0.4.0
OpenAPI 3.1.0

Soumettre une tâche de génération d'image

Felo API Support
MIT
Serveur:https://openapi.felo.ai
Bibliothèques clientes
Shell Curl

Soumettre une tâche de génération d'image

​

Renvoie HTTP 202 avec un task_id persistant. Interrogez GET /api/v1/images/generations/{task_id}. Une entrée à plat ou imbriquée est prise en charge ; l'entrée imbriquée est prioritaire. Les champs callback sont ignorés. Les capacités et les paramètres d'entrée dépendent du modèle et du canal configurés.

En-têtes
  • X-Request-Id
    Type: string

    ID de requête facultatif de l'appelant, renvoyé pour le diagnostic.

  • X-Felo-Channel
    Type: string

    Codes de canaux publics ordonnés, séparés par des virgules. Omettre cet en-tête pour utiliser default ; default doit être utilisé seul. En mode portefeuille, default parcourt l'ordre effectif des canaux publics du modèle dans l'ordre inverse, ignore les canaux non publiés ou indisponibles et sélectionne le fournisseur du premier canal disponible. Il inclut les points de terminaison disponibles de ce fournisseur ayant le même ID de modèle amont et le même niveau de service. Les canaux explicites sont validés dans l'ordre spécifié par le client ; seul le groupe de fournisseurs du premier canal est soumis. Aucun repli automatique vers d'autres fournisseurs. Les anciens en-têtes de fournisseur ne peuvent pas remplacer le routage par canaux.

Corps·ImageGenerationRequest
obligatoire
application/json

L'entrée propre au modèle suit le protocole public configuré du modèle.

  • model
    Type: string
    obligatoire
  • image_urls
    Type: array string[]
  • input
    Type: object

    Entrée imbriquée facultative ; prioritaire sur l'entrée à plat.

    • service_tier
      Type: string | null

      Seule la valeur default (standard) est actuellement prise en charge. Une valeur omise, null, un alias ou une chaîne non prise en charge revient à default ; les autres types renvoient HTTP 400. Les canaux et tarifs configurés restent inchangés. Les API de texte envoient la valeur standard du fournisseur ; les API Decisions et de génération omettent le champ amont.

    • propertyName
      Type: anything
  • n
    Type: integer

    Integer numbers.

  • prompt
    Type: string
  • service_tier
    Type: string | null

    Seule la valeur default (standard) est actuellement prise en charge. Une valeur omise, null, un alias ou une chaîne non prise en charge revient à default ; les autres types renvoient HTTP 400. Les canaux et tarifs configurés restent inchangés. Les API de texte envoient la valeur standard du fournisseur ; les API Decisions et de génération omettent le champ amont.

  • size
    Type: string
  • propertyName
    Type: anything
Réponses
  • 202
    Type: object · ImageGenerationAccepted

    Tâche acceptée

    • kind
      enum
      constante:  
      image
      obligatoire
      valeurs
      • image
    • outputs
      Type: array string[]
      obligatoire

      Vide jusqu'à la réussite de la tâche.

    • status
      enum
      constante:  
      queued
      obligatoire
      valeurs
      • queued
    • task_id
      Type: string
      obligatoire

      ID de tâche à utiliser pour l'interrogation.

    application/json
  • 400
    Type: object · GenerationError

    Requête invalide (modèle inconnu, modes d'entrée mélangés, champs invalides)

    Enveloppe d'erreur compatible OpenAI.

    • error
      Type: object
      • message
        Type: string
        obligatoire
      • type
        Type: string enum
        obligatoire
        valeurs
        • invalid_request_error
        • server_error
      • code
        Type: string
      • param
        Type: string nullable
    application/json
  • 401
    Type: object · GenerationError

    Clé API Felo invalide ou manquante

    Enveloppe d'erreur compatible OpenAI.

    • error
      Type: object
      • message
        Type: string
        obligatoire
      • type
        Type: string enum
        obligatoire
        valeurs
        • invalid_request_error
        • server_error
      • code
        Type: string
      • param
        Type: string nullable
    application/json
  • 402
    Type: object · GenerationError

    Solde insuffisant / condition de facturation non remplie

    Enveloppe d'erreur compatible OpenAI.

    • error
      Type: object
      • message
        Type: string
        obligatoire
      • type
        Type: string enum
        obligatoire
        valeurs
        • invalid_request_error
        • server_error
      • code
        Type: string
      • param
        Type: string nullable
    application/json
  • 403
    Type: object · GenerationError

    Compte non autorisé (abonnement requis ou utilisateur suspendu). Les modèles désactivés sont également rejetés avant tout appel amont. Les requêtes acceptées et les tâches en cours se poursuivent.

    Enveloppe d'erreur compatible OpenAI.

    • error
      Type: object
      • message
        Type: string
        obligatoire
      • type
        Type: string enum
        obligatoire
        valeurs
        • invalid_request_error
        • server_error
      • code
        Type: string
      • param
        Type: string nullable
    application/json
  • 429
    Type: object · GenerationError

    Limite de requêtes ou de dépenses atteinte

    Enveloppe d'erreur compatible OpenAI.

    • error
      Type: object
      • message
        Type: string
        obligatoire
      • type
        Type: string enum
        obligatoire
        valeurs
        • invalid_request_error
        • server_error
      • code
        Type: string
      • param
        Type: string nullable
    application/json
  • 502
    Type: object · GenerationError

    Échec du fournisseur amont

    Enveloppe d'erreur compatible OpenAI.

    • error
      Type: object
      • message
        Type: string
        obligatoire
      • type
        Type: string enum
        obligatoire
        valeurs
        • invalid_request_error
        • server_error
      • code
        Type: string
      • param
        Type: string nullable
    application/json
  • 503
    Type: object · GenerationError

    Service de génération ou service de facturation temporairement indisponible

    Enveloppe d'erreur compatible OpenAI.

    • error
      Type: object
      • message
        Type: string
        obligatoire
      • type
        Type: string enum
        obligatoire
        valeurs
        • invalid_request_error
        • server_error
      • code
        Type: string
      • param
        Type: 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"
  ]
}

Tâche acceptée

Submit an image generation task