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

Загрузить каталог моделей

POST /v1/ai/credentials/:id/fetch-models

Загружает список моделей у провайдера через его адаптер и сохраняет каждую как AiModel. Для Custom-провайдера модели привязываются к этому ключу, для стандартных провайдеров сохраняются в общем каталоге платформы. Если провайдер не поддерживает загрузку каталога — операция возвращает успешный ответ с подсказкой добавить модели вручную; ручная регистрация доступна только для Custom-ключей.

Эндпоинт доступен для ваших USER-ключей любого провайдера, включая custom-openai-compat.

Параметры

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

Тело запроса не передаётся.

Примеры

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

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

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

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/ai/credentials/cred_custom_xyz/fetch-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}/fetch-models`, {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})

const { data } = await res.json()
console.log(`Добавлено: ${data.added}, обновлено: ${data.updated}, помечено устаревшими: ${data.deprecated}`)

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

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

const { data } = await res.json()
if (data.error === 'PROVIDER_LIST_MODELS_UNAVAILABLE') {
  console.log('Не удалось загрузить каталог. Проверьте ключ и доступность провайдера:', data.message)
}

Поля ответа

Поле Тип Описание
success boolean Всегда true
data object Итог загрузки каталога: счётчики моделей и, если провайдер не отдал каталог, поля error, hint, message
data.added number Количество новых AiModel-записей
data.updated number Количество обновлённых записей в каталоге ключа (Custom) или общем каталоге платформы (стандартный провайдер)
data.deprecated number Количество моделей, привязанных к Custom-ключу, которые больше не возвращаются провайдером — их статус автоматически меняется на DEPRECATED
data.error string При сбое создания адаптера или загрузки каталога: PROVIDER_LIST_MODELS_UNAVAILABLE (кроме HTTP-редиректа)
data.hint string Подсказка по дальнейшим действиям при ошибке
data.message string Диагностическое сообщение о сбое создания адаптера или загрузки каталога

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

Успешная загрузка каталога:

JSON 
{
  "success": true,
  "data": {
    "added": 5,
    "updated": 12,
    "deprecated": 0
  }
}

Провайдер не поддерживает GET /v1/models (например, Minimax):

JSON 
{
  "success": true,
  "data": {
    "added": 0,
    "updated": 0,
    "deprecated": 0,
    "error": "PROVIDER_LIST_MODELS_UNAVAILABLE",
    "hint": "add models manually: POST /v1/ai/credentials/cred_custom_xyz/models",
    "message": "OpenAI API 404: page not found"
  }
}

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

400 no_key — в сохранённых данных ключа нет API-ключа:

JSON 
{
  "success": false,
  "error": {
    "code": "no_key",
    "message": "No API key in credentials"
  }
}

Ошибки

HTTP Код Описание
400 no_key В сохранённых данных нет apiKey или api_key
400 base_url_redirect Провайдер ответил HTTP-редиректом; для Custom-ключа укажите конечный адрес API в baseUrl
404 not_found Ключ с таким id не найден или не принадлежит вам
403 scope_missing API-ключу не хватает скоупа vibe:ai

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

Лимит загрузки каталога: 10 запросов в минуту (единая корзина на портал). Точное значение — в заголовке x-ratelimit-limit (потолок делится на реплики).

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

Идемпотентно. Повторный запуск не создаёт дубликатов: существующие модели обновляются (поля name, contextLength, maxOutputTokens), новые добавляются. Для Custom-провайдера поиск идёт в каталоге ключа, для стандартного — в общем каталоге платформы. Только модели, привязанные к Custom-ключу и исчезнувшие из каталога провайдера, получают статус DEPRECATED (история использования сохраняется).

Цены — нулевые. Загруженные модели по умолчанию имеют inputPrice = 0, outputPrice = 0 — BYOK означает, что вы платите провайдеру напрямую. Платформенный биллинг такие записи пропускает.

Сбой загрузки PROVIDER_LIST_MODELS_UNAVAILABLE. Код означает сбой создания адаптера или загрузки каталога (кроме HTTP-редиректа), а не подтверждает отсутствие поддержки каталога. Проверьте data.message, ключ и доступность провайдера. Если подтверждено, что Custom-провайдер не поддерживает каталог моделей, добавьте каждую модель вручную через POST /v1/ai/credentials/:id/models.

Фильтр gpt- — только для OpenAI. Для провайдера openai адаптер оставляет только модели с префиксом gpt-. Для custom-openai-compat и других OpenAI-совместимых провайдеров такого фильтра нет: сохраняются все модели, возвращённые каталогом.

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