Chat Completions — POST /v1/chat/completions

El endpoint /v1/chat/completions genera una completación de texto basada en una lista de mensajes. Es el endpoint principal para tareas de chat, seguimiento de instrucciones y generación de texto. El formato de la solicitud es idéntico al de la API de Chat Completions de OpenAI, por lo que cualquier SDK compatible con OpenAI funciona sin modificaciones.

Endpoint

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

Solicitud

Cabeceras

Cabecera	Valor
`Authorization`	`Bearer $FLATKEY_API_KEY`
`Content-Type`	`application/json`

Parámetros del cuerpo

string

requerido

El ID del modelo a usar. Consulta el Directorio de modelos para todos los valores válidos. Ejemplo: "gpt-4o", "claude-sonnet-4-5", "gemini-2.5-flash".

array

requerido

Un array de objetos de mensaje que representan la conversación. Cada objeto debe tener role ("system", "user" o "assistant") y content (string).

integer

Número máximo de tokens a generar. Los valores por defecto varían según el modelo.

number

Temperatura de muestreo entre 0 y 2. Los valores más altos producen una salida más aleatoria. Por defecto: 1.

boolean

Si es true, la respuesta se devuelve como un flujo de eventos enviados por el servidor (SSE). Por defecto: false.

number

Muestreo por núcleo: solo se consideran los tokens dentro de la masa de probabilidad superior top_p. Por defecto: 1.

string | array

Una o más secuencias en las que el modelo deja de generar. Puede ser una cadena de texto o un array de cadenas.

array

Una lista de definiciones de herramientas para la llamada a funciones. Cada herramienta debe tener type: "function" y un objeto function con name, description y parameters.

string | object

Controla la selección de herramientas: "none", "auto", "required" o una herramienta específica {"type": "function", "function": {"name": "..."}}.

Ejemplo de solicitud

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
  }'

Respuesta

{
  "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 de la respuesta

string

Identificador único de la completación.

array

Array de opciones de completación generadas.

Mostrar propiedades de choice

string

El texto generado.

string

Siempre "assistant" para los mensajes generados.

string

Motivo por el que se detuvo la generación: "stop" (fin natural), "length" (se alcanzó max_tokens), "tool_calls" (herramienta invocada).

object

Recuento de tokens para facturación.

Mostrar propiedades de usage

integer

Recuento de tokens de entrada.

integer

Recuento de tokens de salida.

integer

Suma de los tokens de prompt y completación.

Streaming

Establece stream: true para recibir un flujo de fragmentos SSE. Cada fragmento tiene la misma estructura, pero con contenido delta parcial en lugar de un mensaje completo:

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)

Descripción general

Endpoints

Chat Completions — POST /v1/chat/completions

Endpoint

Solicitud

Cabeceras

Parámetros del cuerpo

Ejemplo de solicitud

Respuesta

Campos de la respuesta

Streaming

​Endpoint

​Solicitud

​Cabeceras

​Parámetros del cuerpo

​Ejemplo de solicitud

​Respuesta

​Campos de la respuesta

​Streaming

Endpoint

Solicitud

Cabeceras

Parámetros del cuerpo

Ejemplo de solicitud

Respuesta

Campos de la respuesta

Streaming