Felo API PlatformFelo API Platform
v0.4.0
OpenAPI 3.1.0

Criar uma resposta de modelo

Servidor:https://openapi.felo.ai
Bibliotecas Cliente

Criar uma resposta de modelo

​

Endpoint compatível com a API Responses da OpenAI. Uma resposta bem-sucedida sem streaming usa o formato do objeto Responses; com stream=true, o endpoint retorna eventos SSE do Responses. Um objeto Responses com falha pode usar status=failed com error={code,message} mesmo quando a própria requisição HTTP foi concluída.

Cabeçalhos
  • 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·ResponsesRequest
obrigatório
application/json
  • input
    obrigatório
    • Tipo: string
  • model
    Tipo: string
    obrigatório
  • include
    Tipo: array string[]
  • instructions
    Tipo: string
  • max_output_tokens
    Tipo: integer
    mín:  
    1

    Integer numbers.

  • metadata
    Tipo: object
    • propertyName
      Tipo: anything
  • previous_response_id
    Tipo: string
  • reasoning
    Tipo: object
    • propertyName
      Tipo: anything
  • 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.

  • store
    Tipo: boolean
  • stream
    Tipo: boolean
  • temperature
    Tipo: number
    mín:  
    0
  • propertyName
    Tipo: anything
  • text
    Tipo: object
    • propertyName
      Tipo: anything
  • tool_choice
    • Tipo: string
  • tools
    Tipo: array object[]
    • propertyName
      Tipo: anything
  • top_p
    Tipo: number
    mín:  
    0
    máx:  
    1
  • propertyName
    Tipo: anything
Respostas
  • 200
    Tipo: object · ResponsesResponse

    Objeto de resposta ou eventos de resposta em streaming

    • id
      Tipo: string
      obrigatório
    • object
      const:  
      response
      obrigatório
    • status
      Tipo: string enum
      obrigatório
      valores
      • completed
      • failed
      • in_progress
      • cancelled
      • queued
      • incomplete
    • error
      Tipo: object · ResponsesError
      • code
        Tipo: string
        obrigatório
      • message
        Tipo: string
        obrigatório
      • propertyName
        Tipo: anything
    • metadata
      Tipo: object
      • propertyName
        Tipo: anything
    • model
      Tipo: string
    • output
      Tipo: array object[]
      • propertyName
        Tipo: anything
    • output_text
      Tipo: string
    • usage
      Tipo: object · Usage

      Objeto de uso do provedor. Os campos variam conforme o endpoint e o provedor.

      • propertyName
        Tipo: anything
    • propertyName
      Tipo: anything
  • 400
    Tipo: object · OpenAIErrorResponse

    Requisição, modelo ou mapeamento de provedor inválido

    Envelope de erro compatível com a OpenAI. O Router pode incluir code e message sem todos os campos upstream opcionais.

    • error
      Tipo: object
      obrigatório
      • message
        Tipo: string
        obrigatório
      • code
        Tipo: string | null
      • param
        Tipo: string | null
      • type
        Tipo: string

        Tipo de erro compatível com a OpenAI, quando fornecido.

      • propertyName
        Tipo: anything
    • propertyName
      Tipo: anything
    application/json
  • 401
    Tipo: object · OpenAIErrorResponse

    Chave de API da Felo inválida ou ausente

    Envelope de erro compatível com a OpenAI. O Router pode incluir code e message sem todos os campos upstream opcionais.

    • error
      Tipo: object
      obrigatório
      • message
        Tipo: string
        obrigatório
      • code
        Tipo: string | null
      • param
        Tipo: string | null
      • type
        Tipo: string

        Tipo de erro compatível com a OpenAI, quando fornecido.

      • propertyName
        Tipo: anything
    • propertyName
      Tipo: anything
    application/json
  • 402
    Tipo: object · OpenAIErrorResponse

    Saldo insuficiente

    Envelope de erro compatível com a OpenAI. O Router pode incluir code e message sem todos os campos upstream opcionais.

    • error
      Tipo: object
      obrigatório
      • message
        Tipo: string
        obrigatório
      • code
        Tipo: string | null
      • param
        Tipo: string | null
      • type
        Tipo: string

        Tipo de erro compatível com a OpenAI, quando fornecido.

      • propertyName
        Tipo: anything
    • propertyName
      Tipo: anything
    application/json
  • 403
    Tipo: object · OpenAIErrorResponse

    A conta não tem permissão para usar o modelo. 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. O Router pode incluir code e message sem todos os campos upstream opcionais.

    • error
      Tipo: object
      obrigatório
      • message
        Tipo: string
        obrigatório
      • code
        Tipo: string | null
      • param
        Tipo: string | null
      • type
        Tipo: string

        Tipo de erro compatível com a OpenAI, quando fornecido.

      • propertyName
        Tipo: anything
    • propertyName
      Tipo: anything
    application/json
  • 429
    Tipo: object · OpenAIErrorResponse

    Limite de gastos ou de requisições atingido

    Envelope de erro compatível com a OpenAI. O Router pode incluir code e message sem todos os campos upstream opcionais.

    • error
      Tipo: object
      obrigatório
      • message
        Tipo: string
        obrigatório
      • code
        Tipo: string | null
      • param
        Tipo: string | null
      • type
        Tipo: string

        Tipo de erro compatível com a OpenAI, quando fornecido.

      • propertyName
        Tipo: anything
    • propertyName
      Tipo: anything
    application/json
  • 502
    Tipo: object · OpenAIErrorResponse

    Falha na requisição ao provedor upstream

    Envelope de erro compatível com a OpenAI. O Router pode incluir code e message sem todos os campos upstream opcionais.

    • error
      Tipo: object
      obrigatório
      • message
        Tipo: string
        obrigatório
      • code
        Tipo: string | null
      • param
        Tipo: string | null
      • type
        Tipo: string

        Tipo de erro compatível com a OpenAI, quando fornecido.

      • propertyName
        Tipo: anything
    • propertyName
      Tipo: anything
    application/json
  • 503
    Tipo: object · OpenAIErrorResponse

    Provedor ou serviço de cobrança indisponível

    Envelope de erro compatível com a OpenAI. O Router pode incluir code e message sem todos os campos upstream opcionais.

    • error
      Tipo: object
      obrigatório
      • message
        Tipo: string
        obrigatório
      • code
        Tipo: string | null
      • param
        Tipo: string | null
      • type
        Tipo: string

        Tipo de erro compatível com a OpenAI, quando fornecido.

      • propertyName
        Tipo: anything
    • propertyName
      Tipo: anything
    application/json
Request Example for post/api/v1/responses
curl https://openapi.felo.ai/api/v1/responses \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "model": "gpt-5.5",
  "input": "Explain why the sky is blue in one sentence.",
  "stream": false
}'
{
  "id": "string",
  "object": "response",
  "status": "completed",
  "output": [
    {
      "additionalProperty": "anything"
    }
  ],
  "output_text": "string",
  "error": {
    "code": "string",
    "message": "string",
    "additionalProperty": "anything"
  },
  "usage": {
    "additionalProperty": "anything"
  },
  "model": "string",
  "metadata": {
    "additionalProperty": "anything"
  },
  "additionalProperty": "anything"
}
Create a model response