Для AI-агентов: markdown этой страницы — /docs-content/chats/copilot/engine.md индекс документации — /llms.txt

Сменить модель CoPilot

PUT /v1/chats/:dialogId/copilot/engine

Переключает модель искусственного интеллекта (AI), которой отвечает CoPilot в чате. Работает только в чате CoPilot. После смены в чате появляется системное сообщение о новой модели.

Параметры

Параметр Тип Обяз. Описание
dialogId (path) string да ID диалога чата CoPilot — chatN. Получить: data.chat.dialogId чернового чата или список диалогов с onlyCopilot=true

Параметры строки запроса не принимаются и отклоняются с 400 INVALID_PARAMS.

Поля запроса (body)

Поле Тип Обяз. Описание
engineCode string да Код модели AI портала. Текущая модель чата — engine в data.copilot.chats загрузки чата

Другие поля тела отклоняются с 400 INVALID_PARAMS.

Примеры

curl — личный ключ

Terminal 
curl -X PUT https://vibecode.bitrix24.tech/v1/chats/chat2001/copilot/engine \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"engineCode": "engine_code"}'

curl — OAuth-приложение

Terminal 
curl -X PUT https://vibecode.bitrix24.tech/v1/chats/chat2001/copilot/engine \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"engineCode": "engine_code"}'

JavaScript — личный ключ

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/chat2001/copilot/engine', {
  method: 'PUT',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ engineCode: 'engine_code' }),
})

const { success, data } = await res.json()
console.log('Модель сменена:', data.result)

JavaScript — OAuth-приложение

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/chat2001/copilot/engine', {
  method: 'PUT',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ engineCode: 'engine_code' }),
})

const { success, data } = await res.json()
console.log('Модель сменена:', data.result)

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data.result boolean true — модель сменена

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

JSON 
{
  "success": true,
  "data": {
    "result": true
  }
}

Пример ответа при ошибке

422 — чат не является чатом CoPilot:

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "WRONG_MESSAGE_TYPE",
    "b24Code": "WRONG_MESSAGE_TYPE"
  }
}

Ошибки

HTTP Код Описание
400 INVALID_PARAMS Нет engineCode или это не непустая строка, передано другое поле тела или параметр строки запроса. Проверяется до обращения к Битрикс24
404 ENTITY_NOT_FOUND Битрикс24 вернул «не найдено». Код портала — в error.b24Code
422 BITRIX_ERROR Битрикс24 отказал с кодом WRONG_MESSAGE_TYPE в error.b24Code — чат не является чатом CoPilot
422 BITRIX_ERROR Битрикс24 отказал с кодом IDENTICAL_ENGINE в error.b24Code — чат уже на этой модели
422 BITRIX_ERROR Битрикс24 отказал с кодом ENGINE_NOT_FOUND в error.b24Code — нет модели с таким кодом
422 BITRIX_ERROR Битрикс24 отказал с кодом COPILOT_NOT_INSTALLED в error.b24Code — CoPilot на портале не установлен
502 ME_ALIAS_RESOLUTION_FAILED Не удалось определить пользователя при использовании алиаса me
403 SCOPE_DENIED API-ключ не имеет скоупа im
403 WRITE_BLOCKED_READONLY_KEY Ключ только для чтения — вызов изменяет чат
401 TOKEN_MISSING API-ключ не имеет настроенных токенов Битрикс24

Полный список общих ошибок API — Ошибки.

Известные особенности

Повторная смена на ту же модель — отказ. Перед сменой сравните engine из data.copilot.chats с нужной моделью.

Выбор запоминается. Модель сохраняется как последняя выбранная пользователем.

Смотрите также