Felo API PlatformFelo API Platform
v0.4.0
OpenAPI 3.1.0

Enviar una tarea de generación de imágenes

Felo API Support
MIT
Servidor:https://openapi.felo.ai
Bibliotecas cliente
Shell Curl

Enviar una tarea de generación de imágenes

​

Devuelve HTTP 202 con un task_id persistente. Consulta GET /api/v1/images/generations/{task_id}. Se admite la entrada plana o anidada; la entrada anidada tiene prioridad. Los campos callback se ignoran. Las capacidades y los parámetros de entrada dependen del modelo y del canal configurados.

Encabezados
  • X-Request-Id
    Tipo: string

    ID de solicitud opcional del cliente que se devuelve para diagnóstico.

  • X-Felo-Channel
    Tipo: string

    Códigos de canal públicos separados por comas y en orden. Omite este encabezado para usar default; default debe usarse solo. En modo monedero, default recorre en orden inverso el orden efectivo de canales públicos del modelo, omite los canales no publicados o no disponibles y selecciona el proveedor del primer canal disponible. Incluye los endpoints disponibles de ese proveedor con el mismo ID de modelo upstream y el mismo nivel de servicio. Los canales explícitos se validan en el orden indicado por el cliente; solo se envía el grupo de proveedores del primer canal. No hay respaldo automático a otros proveedores. Los encabezados de proveedor heredados no pueden anular el enrutamiento por canales.

Cuerpo·ImageGenerationRequest
obligatorio
application/json

La entrada específica del modelo sigue el protocolo público configurado del modelo.

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

    Entrada anidada opcional; tiene prioridad sobre la entrada plana.

    • service_tier
      Tipo: string | null

      Actualmente solo se admite default (estándar). Si se omite, es null, es un alias o es una cadena no admitida, se usa default; otros tipos devuelven HTTP 400. Los canales y precios configurados no cambian. Las API de texto envían el valor estándar del proveedor; las API Decisions y de generación omiten el campo upstream.

    • propertyName
      Tipo: anything
  • n
    Tipo: integer

    Integer numbers.

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

    Actualmente solo se admite default (estándar). Si se omite, es null, es un alias o es una cadena no admitida, se usa default; otros tipos devuelven HTTP 400. Los canales y precios configurados no cambian. Las API de texto envían el valor estándar del proveedor; las API Decisions y de generación omiten el campo upstream.

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

    Tarea aceptada

    • kind
      enum
      constante:  
      image
      obligatorio
      valores
      • image
    • outputs
      Tipo: array string[]
      obligatorio

      Vacío hasta que la tarea finaliza correctamente.

    • status
      enum
      constante:  
      queued
      obligatorio
      valores
      • queued
    • task_id
      Tipo: string
      obligatorio

      ID de tarea que se usará para consultar el estado.

    application/json
  • 400
    Tipo: object · GenerationError

    Solicitud no válida (modelo desconocido, modos de entrada mezclados, campos no válidos)

    Envoltorio de error compatible con OpenAI.

    • error
      Tipo: object
      • message
        Tipo: string
        obligatorio
      • type
        Tipo: string enum
        obligatorio
        valores
        • invalid_request_error
        • server_error
      • code
        Tipo: string
      • param
        Tipo: string admite null
    application/json
  • 401
    Tipo: object · GenerationError

    Clave de API de Felo no válida o ausente

    Envoltorio de error compatible con OpenAI.

    • error
      Tipo: object
      • message
        Tipo: string
        obligatorio
      • type
        Tipo: string enum
        obligatorio
        valores
        • invalid_request_error
        • server_error
      • code
        Tipo: string
      • param
        Tipo: string admite null
    application/json
  • 402
    Tipo: object · GenerationError

    Saldo insuficiente o requisito de facturación no cumplido

    Envoltorio de error compatible con OpenAI.

    • error
      Tipo: object
      • message
        Tipo: string
        obligatorio
      • type
        Tipo: string enum
        obligatorio
        valores
        • invalid_request_error
        • server_error
      • code
        Tipo: string
      • param
        Tipo: string admite null
    application/json
  • 403
    Tipo: object · GenerationError

    La cuenta no tiene permiso (se requiere suscripción o el usuario está bloqueado). Los modelos deshabilitados también se rechazan antes de las llamadas upstream. Las solicitudes y tareas ya aceptadas continúan.

    Envoltorio de error compatible con OpenAI.

    • error
      Tipo: object
      • message
        Tipo: string
        obligatorio
      • type
        Tipo: string enum
        obligatorio
        valores
        • invalid_request_error
        • server_error
      • code
        Tipo: string
      • param
        Tipo: string admite null
    application/json
  • 429
    Tipo: object · GenerationError

    Se alcanzó el límite de solicitudes o de gasto

    Envoltorio de error compatible con OpenAI.

    • error
      Tipo: object
      • message
        Tipo: string
        obligatorio
      • type
        Tipo: string enum
        obligatorio
        valores
        • invalid_request_error
        • server_error
      • code
        Tipo: string
      • param
        Tipo: string admite null
    application/json
  • 502
    Tipo: object · GenerationError

    Error del proveedor upstream

    Envoltorio de error compatible con OpenAI.

    • error
      Tipo: object
      • message
        Tipo: string
        obligatorio
      • type
        Tipo: string enum
        obligatorio
        valores
        • invalid_request_error
        • server_error
      • code
        Tipo: string
      • param
        Tipo: string admite null
    application/json
  • 503
    Tipo: object · GenerationError

    Servicio de generación o servicio de facturación no disponible temporalmente

    Envoltorio de error compatible con OpenAI.

    • error
      Tipo: object
      • message
        Tipo: string
        obligatorio
      • type
        Tipo: string enum
        obligatorio
        valores
        • invalid_request_error
        • server_error
      • code
        Tipo: string
      • param
        Tipo: string admite 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"
  ]
}

Tarea aceptada

Submit an image generation task