docs
API

Responses

Markdown

Novo formato OpenAI: uma entrada, saída tipada, ferramentas e raciocínio. É utilizado pelo Codex CLI.

Guia completo
POSThttps://api.ailoot.ai/v1/responses
Responses
curl https://api.ailoot.ai/v1/responses \
  -H "Authorization: Bearer $AILOOT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-6.1-sol",
    "instructions": "Responda de forma breve.",
    "input": "Qual é a diferença entre TCP e UDP?"
  }' 
200 OK
{
  "id": "resp_67f1…",
  "object": "response",
  "status": "completed",
  "model": "gpt-6.1-sol",
  "output": [
    {
      "type": "message",
      "role": "assistant",
      "content": [
        { "type": "output_text", "text": "O TCP garante a entrega e a ordem; o UDP não, mas é mais rápido…" }
      ]
    }
  ],
  "usage": { "input_tokens": 24, "output_tokens": 61, "total_tokens": 85 }
}

Autorização

  • Authorizationheaderobrigatório

    Chave no formato Bearer sk-…. Também são aceites os cabeçalhos x-api-key ou x-goog-api-key.

Corpo do pedido

  • modelstringobrigatório

    ID de um modelo com o formato Responses. Existem 53 no catálogo: GPT, Claude, DeepSeek, Qwen, Kimi, GLM, MiniMax e Grok. Os modelos Gemini não estão disponíveis neste formato.

  • inputstring | arrayobrigatório

    Texto do pedido ou array de mensagens e partes (texto, imagens).

  • instructionsstringopcional

    Instrução de sistema.

  • streambooleanopcional

    Fluxo de eventos SSE; o último evento é response.completed. O texto pago chega num único bloco após o cálculo do custo.

  • max_output_tokensintegeropcional

    Número máximo de tokens da resposta, incluindo o raciocínio. Se não o indicar, o Ailoot utiliza 4096 (ou menos, se o limite de resposta do modelo for inferior). Para respostas longas, defina o limite explicitamente. Os pedidos com previous_response_id e com ferramentas incorporadas web_search ou code_interpreter têm em conta, nos novos pedidos de texto, estimativas separadas do contexto guardado e do trabalho das ferramentas; não passam automaticamente a reservar o custo de toda a janela de entrada. As reservas anteriormente aceites mantêm as condições originais. Para imagens, vídeo e áudio gerados, é reservado o custo total do resultado. Se a reserva calculada exceder o saldo disponível ou o limite da chave, o Ailoot pode, para um modelo e um método suportados, reduzir max_tokens (max_output_tokens em Responses) até ao volume que pode ser pago, sem ficar abaixo de 256 tokens ou de um mínimo superior exigido pelo método, e comunica essa redução no cabeçalho X-Ailoot-Max-Tokens-Capped. A possibilidade de redução é verificada para o modelo de texto e o método específicos. Aplica-se às rotas de texto Gemini suportadas, no formato nativo Gemini e no formato Anthropic Messages; deepseek-ai/deepseek-v4.1-flash, meta/llama-3.2-11b-vision-instruct, meta/muse-glimmer-30b, nvidia/ising-calibration-1.5-31b, nvidia/nemotron-3-nano-omni-30b-a3b-reasoning, nvidia/nemotron-3-super-120b-a12b, nvidia/nemotron-3-ultra-550b-a55b, nvidia/nemotron-3.5-content-safety, nvidia/nemotron-3.5-lightning-30b-a3b, nvidia/riva-translate-4b-instruct-v1.1, nvidia/riva-translate-4b-instruct-v2, poolside/laguna-xs-2.1, z-ai/glm-5.3-flash — nos formatos Chat Completions e Messages (quando suportados pelo modelo). Saída é estimada, no cálculo da reserva de um novo pedido de texto, com base no comprimento típico da resposta e nas condições aceites. O limite solicitado é definido através de max_tokens (max_output_tokens em Responses). O limite solicitado não é automaticamente igual ao número de tokens utilizado no cálculo da reserva nem garante o comprimento efetivo da resposta de um modelo sem uma limitação fiável. O valor inicial de 4096 aplica-se apenas às rotas correspondentes; a regra concreta depende do modelo e do método.

  • reasoningobjectopcional

    {"effort": "low" | "medium" | "high"} para modelos de raciocínio.

  • toolsarrayopcional

    Funções que o modelo pode chamar.

  • textobjectopcional

    Formato da resposta, por exemplo {"format": {"type": "json_schema", ...}}.

  • temperaturenumberopcional

    Aleatoriedade da resposta, se o modelo a suportar.

Resposta

  • outputarray

    Elementos da resposta: mensagens (message), raciocínio, chamadas de funções. No SDK, é cómodo utilizar output_text.

  • statusstring

    completed, incomplete (atingiu o limite) ou failed.

  • usageobject

    input_tokens, output_tokens, total_tokens.

Ainda tem dúvidas? Envie o Request ID e uma descrição — ajudamos a esclarecer.Contactar o suporte