Chat Completions — POST /v1/chat/completions

Эндпоинт /v1/chat/completions генерирует текстовое завершение на основе списка сообщений. Это основной эндпоинт для задач чата, следования инструкциям и генерации текста. Формат запроса идентичен OpenAI Chat Completions API, поэтому любой совместимый с OpenAI SDK работает без изменений.

Эндпоинт

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

Запрос

Заголовки

Заголовок	Значение
`Authorization`	`Bearer $FLATKEY_API_KEY`
`Content-Type`	`application/json`

Параметры тела запроса

string

обязательно

Идентификатор модели для использования. Все допустимые значения см. в каталоге моделей. Пример: "gpt-4o", "claude-sonnet-4-5", "gemini-2.5-flash".

array

обязательно

Массив объектов сообщений, представляющих беседу. Каждый объект должен иметь role ("system", "user" или "assistant") и content (строка).

integer

Максимальное количество токенов для генерации. Значения по умолчанию зависят от модели.

number

Температура сэмплирования от 0 до 2. Более высокие значения дают более случайный результат. По умолчанию: 1.

boolean

Если true, ответ возвращается в виде потока событий, отправляемых сервером (SSE). По умолчанию: false.

number

Ядерное сэмплирование — рассматриваются только токены в верхней части вероятностной массы top_p. По умолчанию: 1.

string | array

Одна или несколько последовательностей, при достижении которых модель прекращает генерацию. Может быть строкой или массивом строк.

array

Список определений инструментов для вызова функций. Каждый инструмент должен иметь type: "function" и объект function с полями name, description и parameters.

string | object

Управляет выбором инструмента: "none", "auto", "required" или конкретный инструмент {"type": "function", "function": {"name": "..."}}.

Пример запроса

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

Ответ

{
  "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
  }
}

Поля ответа

string

Уникальный идентификатор завершения.

array

Массив сгенерированных вариантов завершения.

Показать свойства варианта

string

Сгенерированный текст.

string

Всегда "assistant" для сгенерированных сообщений.

string

Причина остановки генерации: "stop" (естественное завершение), "length" (достигнут max_tokens), "tool_calls" (вызван инструмент).

object

Количество токенов для тарификации.

Показать свойства usage

integer

Количество входных токенов.

integer

Количество выходных токенов.

integer

Сумма токенов запроса и завершения.

Потоковая передача

Установите stream: true, чтобы получать поток фрагментов SSE. Каждый фрагмент имеет ту же структуру, но содержит частичное содержимое delta вместо полного сообщения:

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)

Обзор

Эндпоинты

Chat Completions — POST /v1/chat/completions

Эндпоинт

Запрос

Заголовки

Параметры тела запроса

Пример запроса

Ответ

Поля ответа

Потоковая передача

​Эндпоинт

​Запрос

​Заголовки

​Параметры тела запроса

​Пример запроса

​Ответ

​Поля ответа

​Потоковая передача

Эндпоинт

Запрос

Заголовки

Параметры тела запроса

Пример запроса

Ответ

Поля ответа

Потоковая передача