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

Список моделей ключа

GET /v1/ai/credentials/:id/models

Возвращает все модели, привязанные к указанному личному ключу провайдера (BYOK) через fetch-models или models-add. Используется для просмотра текущего каталога ключа и поиска id записи перед удалением.

Требуется скоуп vibe:ai. Публичный API работает только с вашим USER-ключом. Чужой, несуществующий или PORTAL-ключ возвращает 404 not_found.

Параметры

Параметр Тип Обяз. Описание
Параметрid (path) Типstring Обяз.да ОписаниеID ключа из GET /v1/ai/credentials

Примеры

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

Terminal 
curl https://vibecode.bitrix24.tech/v1/ai/credentials/cred_custom_xyz/models \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl https://vibecode.bitrix24.tech/v1/ai/credentials/cred_custom_xyz/models \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript 
const id = 'cred_custom_xyz'
const res = await fetch(`https://vibecode.bitrix24.tech/v1/ai/credentials/${id}/models`, {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})

const { data } = await res.json()
data.forEach((m) => console.log(`${m.modelId} — ${m.name} (${m.status})`))

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

javascript 
const id = 'cred_custom_xyz'
const res = await fetch(`https://vibecode.bitrix24.tech/v1/ai/credentials/${id}/models`, {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { data } = await res.json()
console.log('Моделей у ключа:', data.length)

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean ОписаниеВсегда true при успехе
Полеdata Типarray ОписаниеМассив привязанных моделей
Полеdata[].id Типstring ОписаниеУникальный ID записи AiModel (нужен для удаления)
Полеdata[].modelId Типstring ОписаниеID модели с префиксом провайдера <slug>/ для использования в model запроса к /v1/chat/completions
Полеdata[].name Типstring ОписаниеОтображаемое название модели
Полеdata[].status Типstring ОписаниеСтатус: ACTIVE, DEPRECATED, DISABLED
Полеdata[].contextLength Типnumber ОписаниеМаксимальный размер контекста в токенах
Полеdata[].maxOutputTokens Типinteger или null ОписаниеМаксимальный ответ в токенах
Полеdata[].capabilities Типobject или null ОписаниеВозможности модели
Полеdata[].description Типstring или null ОписаниеОписание модели
Полеdata[].createdAt Типstring ОписаниеВремя первой регистрации в ISO 8601

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

JSON 
{
  "success": true,
  "data": [
    {
      "id": "aimodel_xyz789",
      "modelId": "custom-openai-compat/abab6.5-chat",
      "name": "MiniMax abab6.5-chat",
      "contextLength": 32768,
      "status": "ACTIVE",
      "createdAt": "2026-04-25T09:00:00.000Z"
    },
    {
      "id": "aimodel_old001",
      "modelId": "custom-openai-compat/old-model-v1",
      "name": "Старая модель",
      "contextLength": 16384,
      "status": "DEPRECATED",
      "createdAt": "2026-04-15T09:00:00.000Z"
    }
  ]
}

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

404 not_found — ключ не найден или принадлежит другому пользователю:

JSON 
{
  "success": false,
  "error": {
    "code": "not_found",
    "message": "Credential not found"
  }
}

Ошибки

HTTP Код Описание
HTTP404 Кодnot_found ОписаниеКлюч с таким id не найден или не принадлежит вам
HTTP403 Кодscope_missing ОписаниеAPI-ключу не хватает скоупа vibe:ai
HTTP401 КодMISSING_API_KEY ОписаниеНе передан заголовок X-Api-Key

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

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

status: DEPRECATED после fetch-models. Если модель ранее была загружена через fetch-models, но в последнем запуске больше не пришла от провайдера — её статус автоматически меняется на DEPRECATED. Запросы к ней ещё работают, и она остаётся в каталоге GET /v1/models без признака устаревания. Статус возвращается только в списке моделей ключа — GET /v1/ai/credentials/:id/models.

Работает для всех провайдеров, не только для Custom-провайдера. Эндпоинт возвращает любые модели, привязанные к ключу. Пустой data означает, что модели с этим ключом ещё не подключались через fetch-models или models-add. Модели каталога платформы (credentialId: null) к ключу не привязаны и в этот список не входят.

id нужен для удаления. Чтобы удалить модель — сохраните id записи и передайте в DELETE /v1/ai/credentials/:credId/models/:modelRowId. modelId не подходит — он не уникален между ключами.

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