Chat Completions — POST /v1/chat/completions

O endpoint /v1/chat/completions gera uma completion de texto com base em uma lista de mensagens. É o endpoint principal para tarefas de chat, seguimento de instruções e geração de texto. O formato da requisição é idêntico ao da API Chat Completions da OpenAI, portanto qualquer SDK compatível com OpenAI funciona sem modificações.

Endpoint

POST https://router.flatkey.ai/v1/chat/completions

Requisição

Cabeçalhos

Cabeçalho	Valor
`Authorization`	`Bearer $FLATKEY_API_KEY`
`Content-Type`	`application/json`

Parâmetros do corpo

string

obrigatório

O ID do modelo a ser usado. Consulte o Diretório de Modelos para todos os valores válidos. Exemplo: "gpt-4o", "claude-sonnet-4-5", "gemini-2.5-flash".

array

obrigatório

Um array de objetos de mensagem representando a conversa. Cada objeto deve ter role ("system", "user" ou "assistant") e content (string).

integer

Número máximo de tokens a gerar. Os valores padrão variam por modelo.

number

Temperatura de amostragem entre 0 e 2. Valores mais altos produzem saídas mais aleatórias. Padrão: 1.

boolean

Se true, a resposta é retornada como um stream de eventos enviados pelo servidor (SSE). Padrão: false.

number

Amostragem por núcleo — somente tokens na massa de probabilidade top_p superior são considerados. Padrão: 1.

string | array

Uma ou mais sequências onde o modelo para de gerar. Pode ser uma string ou um array de strings.

array

Uma lista de definições de ferramentas para chamada de funções. Cada ferramenta deve ter type: "function" e um objeto function com name, description e parameters.

string | object

Controla a seleção de ferramentas: "none", "auto", "required" ou uma ferramenta específica {"type": "function", "function": {"name": "..."}}.

Exemplo de requisição

import os
from openai import OpenAI

client = OpenAI(
    api_key=os.environ["FLATKEY_API_KEY"],
    base_url="https://router.flatkey.ai/v1",
)

response = client.chat.completions.create(
    model="gpt-4o",
    messages=[
        {"role": "system", "content": "You are a helpful assistant."},
        {"role": "user", "content": "What is the speed of light?"},
    ],
    max_tokens=256,
    temperature=0.7,
)

print(response.choices[0].message.content)

curl https://router.flatkey.ai/v1/chat/completions \
  -H "Authorization: Bearer $FLATKEY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-4o",
    "messages": [
      {"role": "system", "content": "You are a helpful assistant."},
      {"role": "user", "content": "What is the speed of light?"}
    ],
    "max_tokens": 256
  }'

Resposta

{
  "id": "chatcmpl-abc123",
  "object": "chat.completion",
  "created": 1710000000,
  "model": "gpt-4o",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "The speed of light in a vacuum is approximately 299,792,458 meters per second."
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 28,
    "completion_tokens": 22,
    "total_tokens": 50
  }
}

Campos da resposta

string

Identificador único para a completion.

array

Array de choices de completion geradas.

Mostrar propriedades de choice

string

O texto gerado.

string

Sempre "assistant" para mensagens geradas.

string

Motivo pelo qual a geração parou: "stop" (fim natural), "length" (max_tokens atingido), "tool_calls" (ferramenta invocada).

object

Contagem de tokens para faturamento.

Mostrar propriedades de usage

integer

Contagem de tokens de entrada.

integer

Contagem de tokens de saída.

integer

Soma dos tokens de prompt e completion.

Streaming

Defina stream: true para receber um stream de chunks SSE. Cada chunk tem a mesma estrutura, mas com conteúdo delta parcial em vez de uma mensagem completa:

python

import os
from openai import OpenAI

client = OpenAI(
    api_key=os.environ["FLATKEY_API_KEY"],
    base_url="https://router.flatkey.ai/v1",
)

stream = client.chat.completions.create(
    model="gpt-4o-mini",
    messages=[{"role": "user", "content": "Tell me a story."}],
    stream=True,
)

for chunk in stream:
    print(chunk.choices[0].delta.content or "", end="", flush=True)

Visão geral

Endpoints

Chat Completions — POST /v1/chat/completions

Endpoint

Requisição

Cabeçalhos

Parâmetros do corpo

Exemplo de requisição

Resposta

Campos da resposta

Streaming

​Endpoint

​Requisição

​Cabeçalhos

​Parâmetros do corpo

​Exemplo de requisição

​Resposta

​Campos da resposta

​Streaming

Endpoint

Requisição

Cabeçalhos

Parâmetros do corpo

Exemplo de requisição

Resposta

Campos da resposta

Streaming