GetRouterДокументация
  • Русский

    • Создать ответ в чате

    Создаёт ответ модели на основе истории диалога. Поддерживает потоковые и непотоковые ответы. Совместимо с OpenAI Chat Completions API.

    POST /v1/chat/completions

    Корневой адрес сервиса: https://getrouter.ai

    Протокол: OpenAI Chat Completions

    Аутентификация: Authorization: Bearer YOUR_API_KEY

    Тело запроса

    Тело запроса обязательно. Тип содержимого: application/json

    Поля запроса

    ПолеТипОбязательноОписание
    modelstringДаID модели
    messagesarray<object>ДаСписок сообщений диалога
    temperaturenumberНетТемпература сэмплирования По умолчанию: 1; Диапазон: 0–2
    top_pnumberНетПараметр ядерной выборки По умолчанию: 1; Диапазон: 0–1
    nintegerНетКоличество генерируемых вариантов По умолчанию: 1; Диапазон: 1–∞
    streambooleanНетИспользовать ли потоковый ответ По умолчанию: false
    stream_optionsobjectНет—
    stopstring or array<string>НетСтоп-последовательности
    max_tokensintegerНетМаксимальное количество генерируемых токенов
    max_completion_tokensintegerНетМаксимальное количество токенов в ответе
    presence_penaltynumberНетПо умолчанию: 0; Диапазон: -2–2
    frequency_penaltynumberНетПо умолчанию: 0; Диапазон: -2–2
    logit_biasobjectНет—
    userstringНет—
    toolsarray<object>Нет—
    tool_choicestring or objectНет—
    response_formatobjectНет—
    seedintegerНет—
    reasoning_effortstringНетИнтенсивность рассуждений (для моделей с поддержкой рассуждений) Допустимые значения: low, medium, high
    modalitiesarray<string>Нет—
    audioobjectНет—

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

    curl --request POST \
  --url https://getrouter.ai/v1/chat/completions \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "model": "MODEL_ID",
  "messages": [
    {
      "role": "system",
      "content": "Здравствуйте! Расскажите о себе."
    }
  ],
  "stream": false,
  "temperature": 1,
  "max_tokens": 1
}'

    Ответы

    СтатусОписание
    200Ответ успешно создан
    400Некорректные параметры запроса
    429Превышен лимит частоты запросов

    Поля успешного ответа

    ПолеТипОбязательноОписание
    idstringНет—
    objectstringНет—
    createdintegerНет—
    modelstringНет—
    choicesarray<object>Нет—
    usageobjectНет—
    system_fingerprintstringНет—

    Пример ответа

    {
  "id": "string",
  "object": "object",
  "created": 1,
  "model": "MODEL_ID",
  "choices": [
    {
      "index": 1,
      "message": {
        "role": "system",
        "content": "Здравствуйте! Расскажите о себе.",
        "name": "string",
        "tool_calls": [
          {
            "id": null,
            "type": null,
            "function": null
          }
        ],
        "tool_call_id": "string",
        "reasoning_content": "string"
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 1,
    "completion_tokens": 1,
    "total_tokens": 1,
    "prompt_tokens_details": {
      "cached_tokens": 1,
      "text_tokens": 1,
      "audio_tokens": 1,
      "image_tokens": 1
    },
    "completion_tokens_details": {
      "text_tokens": 1,
      "audio_tokens": 1,
      "reasoning_tokens": 1
    }
  },
  "system_fingerprint": "string"
}

    Связанное руководство

    Подробные сценарии и примеры приведены в руководстве по API Chat Completions.

    Эта страница создана из публичной спецификации Relay OpenAPI. Полная спецификация доступна в API Explorer.