Felo API PlatformFelo API Platform
v0.4.0
OpenAPI 3.1.0

Enviar uma tarefa de geração de imagem

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

Enviar uma tarefa de geração de imagem

​

Retorna HTTP 202 com um task_id persistente. Consulte GET /api/v1/images/generations/{task_id}. Entrada achatada ou aninhada é aceita; a entrada aninhada tem precedência. Campos de callback são ignorados. As capacidades e os parâmetros de entrada dependem do modelo e do canal configurados.

Cabeçalhos
  • X-Request-Id
    Tipo: string

    ID de requisição do chamador, opcional, retornado na resposta para diagnóstico.

  • X-Felo-Channel
    Tipo: string

    Códigos de canal público separados por vírgula, em ordem. Omita este cabeçalho para usar default; default deve ser usado sozinho. No modo carteira, default percorre a ordem efetiva de canais públicos do modelo em ordem inversa, ignora canais não publicados ou indisponíveis e seleciona o provedor do primeiro canal disponível. Inclui os endpoints disponíveis desse provedor com o mesmo ID de modelo upstream e o mesmo service tier. Canais explícitos são validados na ordem especificada pelo cliente; somente o grupo de provedores do primeiro canal é enviado. Não há fallback automático para outros provedores. Cabeçalhos legados de provedor não podem substituir o roteamento por canal.

Corpo·ImageGenerationRequest
obrigatório
application/json

A entrada específica do modelo segue o protocolo público do modelo configurado.

  • model
    Tipo: string
    obrigatório
  • image_urls
    Tipo: array string[]
  • input
    Tipo: object

    Entrada aninhada opcional; tem precedência sobre a entrada achatada.

    • service_tier
      Tipo: string | null

      Atualmente, apenas default (standard) é suportado. Valores omitidos, null, aliases e strings não suportadas usam default; outros tipos retornam HTTP 400. Os canais e preços configurados permanecem inalterados. As APIs de texto enviam o valor padrão do provedor; as APIs Decisions e de geração omitem o campo upstream.

    • propertyName
      Tipo: anything
  • n
    Tipo: integer

    Integer numbers.

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

    Atualmente, apenas default (standard) é suportado. Valores omitidos, null, aliases e strings não suportadas usam default; outros tipos retornam HTTP 400. Os canais e preços configurados permanecem inalterados. As APIs de texto enviam o valor padrão do provedor; as APIs Decisions e de geração omitem o campo upstream.

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

    Tarefa aceita

    • kind
      enum
      const:  
      image
      obrigatório
      valores
      • image
    • outputs
      Tipo: array string[]
      obrigatório

      Vazio até a tarefa ser concluída com sucesso.

    • status
      enum
      const:  
      queued
      obrigatório
      valores
      • queued
    • task_id
      Tipo: string
      obrigatório

      ID da tarefa a ser usado no polling.

    application/json
  • 400
    Tipo: object · GenerationError

    Requisição inválida (modelo desconhecido, modos de entrada misturados, campos inválidos)

    Envelope de erro compatível com a OpenAI.

    • error
      Tipo: object
      • message
        Tipo: string
        obrigatório
      • type
        Tipo: string enum
        obrigatório
        valores
        • invalid_request_error
        • server_error
      • code
        Tipo: string
      • param
        Tipo: string aceita nulo
    application/json
  • 401
    Tipo: object · GenerationError

    Chave de API da Felo inválida ou ausente

    Envelope de erro compatível com a OpenAI.

    • error
      Tipo: object
      • message
        Tipo: string
        obrigatório
      • type
        Tipo: string enum
        obrigatório
        valores
        • invalid_request_error
        • server_error
      • code
        Tipo: string
      • param
        Tipo: string aceita nulo
    application/json
  • 402
    Tipo: object · GenerationError

    Saldo insuficiente / requisito de cobrança não atendido

    Envelope de erro compatível com a OpenAI.

    • error
      Tipo: object
      • message
        Tipo: string
        obrigatório
      • type
        Tipo: string enum
        obrigatório
        valores
        • invalid_request_error
        • server_error
      • code
        Tipo: string
      • param
        Tipo: string aceita nulo
    application/json
  • 403
    Tipo: object · GenerationError

    Conta sem permissão (assinatura necessária ou usuário banido). Modelos desativados também são rejeitados antes das chamadas upstream. Requisições e tarefas já aceitas continuam.

    Envelope de erro compatível com a OpenAI.

    • error
      Tipo: object
      • message
        Tipo: string
        obrigatório
      • type
        Tipo: string enum
        obrigatório
        valores
        • invalid_request_error
        • server_error
      • code
        Tipo: string
      • param
        Tipo: string aceita nulo
    application/json
  • 429
    Tipo: object · GenerationError

    Limite de requisições ou de gastos atingido

    Envelope de erro compatível com a OpenAI.

    • error
      Tipo: object
      • message
        Tipo: string
        obrigatório
      • type
        Tipo: string enum
        obrigatório
        valores
        • invalid_request_error
        • server_error
      • code
        Tipo: string
      • param
        Tipo: string aceita nulo
    application/json
  • 502
    Tipo: object · GenerationError

    Falha no provedor upstream

    Envelope de erro compatível com a OpenAI.

    • error
      Tipo: object
      • message
        Tipo: string
        obrigatório
      • type
        Tipo: string enum
        obrigatório
        valores
        • invalid_request_error
        • server_error
      • code
        Tipo: string
      • param
        Tipo: string aceita nulo
    application/json
  • 503
    Tipo: object · GenerationError

    Serviço de geração ou serviço de cobrança temporariamente indisponível

    Envelope de erro compatível com a OpenAI.

    • error
      Tipo: object
      • message
        Tipo: string
        obrigatório
      • type
        Tipo: string enum
        obrigatório
        valores
        • invalid_request_error
        • server_error
      • code
        Tipo: string
      • param
        Tipo: string aceita nulo
    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"
  ]
}

Tarefa aceita

Submit an image generation task