Для AI-агентов: markdown этой страницы — /docs-content/entities/sites/ai/generate.md индекс документации — /llms.txt
Запустить генерацию сайта
POST /v1/sites/ai/generate
Запускает генерацию сайта по текстовому описанию.
Параметры
| Параметр | Тип | Обяз. | По умолч. | Описание |
|---|---|---|---|---|
ПараметрIdempotency-Key (header) |
Типstring | Обяз.нет | По умолч.отсутствует | ОписаниеНепустой ключ клиента передаётся без изменений. Пустой или пробельный считается отсутствующим |
Поля запроса (body)
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
Полеdescription |
Типstring | Обяз.да | ОписаниеОписание сайта, не более 4000 символов. Проверяет Битрикс24 |
Примеры
curl — личный ключ
curl -X POST "https://vibecode.bitrix24.tech/v1/sites/ai/generate" \
-H "X-Api-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: example-site-generation-1" \
-d '{"description": "A small demonstration website for a flower shop. This is an API integration test."}'
curl — OAuth-приложение
curl -X POST "https://vibecode.bitrix24.tech/v1/sites/ai/generate" \
-H "X-Api-Key: YOUR_APP_KEY" \
-H "Authorization: Bearer USER_SESSION_TOKEN" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: example-site-generation-1" \
-d '{"description": "A small demonstration website for a flower shop. This is an API integration test."}'
JavaScript — личный ключ
const res = await fetch("https://vibecode.bitrix24.tech/v1/sites/ai/generate", {
"method": "POST",
"headers": {
"X-Api-Key": "YOUR_API_KEY",
"Content-Type": "application/json",
"Idempotency-Key": "example-site-generation-1"
},
"body": JSON.stringify({"description": "A small demonstration website for a flower shop. This is an API integration test."})
});
const result = await res.json();
console.log(result);
JavaScript — OAuth-приложение
const res = await fetch("https://vibecode.bitrix24.tech/v1/sites/ai/generate", {
"method": "POST",
"headers": {
"X-Api-Key": "YOUR_APP_KEY",
"Authorization": "Bearer USER_SESSION_TOKEN",
"Content-Type": "application/json",
"Idempotency-Key": "example-site-generation-1"
},
"body": JSON.stringify({"description": "A small demonstration website for a flower shop. This is an API integration test."})
});
const result = await res.json();
console.log(result);
Поля ответа
| Поле | Тип | Описание |
|---|---|---|
Полеsuccess |
Типboolean | Описаниеtrue при успехе |
Полеdata |
Типobject | ОписаниеСостояние генерации |
Полеdata.id |
Типnumber | ОписаниеИдентификатор генерации |
Полеdata.status |
Типstring | Описаниеrunning, completed или failed |
Полеdata.siteId |
Типnumber | ОписаниеИдентификатор созданного сайта, до создания 0; сайты |
Полеdata.pageId |
Типnumber | ОписаниеИдентификатор созданной страницы, до создания 0; страницы |
Полеdata.draftSiteId |
Типnumber | ОписаниеИдентификатор черновика сайта при сбое, иначе 0 |
Полеdata.draftPageId |
Типnumber | ОписаниеИдентификатор черновика страницы при сбое, иначе 0 |
Полеdata.message |
Типstring | ОписаниеТекст состояния; для условий используйте status |
Полеdata.error |
Типstring | null | ОписаниеПричина сбоя или null |
Полеdata.errorDetails |
Типstring | null | ОписаниеПодробность ограничения запросов или null |
Пример ответа
{
"success": true,
"data": {
"id": 11,
"status": "running",
"siteId": 0,
"pageId": 0,
"draftSiteId": 0,
"draftPageId": 0,
"message": "Сайт генерируется",
"error": null,
"errorDetails": null
}
}
Пример ответа при ошибке
400 — Битрикс24 отказал в запросе:
{
"success": false,
"error": {
"code": "INVALID_PARAMS",
"message": "Ошибка при валидации объекта запроса"
}
}
Ошибки
| HTTP | Код | Описание |
|---|---|---|
| HTTP400 | КодINVALID_PARAMS |
ОписаниеБитрикс24 отказал в запросе |
| HTTP401 | КодMISSING_API_KEY |
ОписаниеНе передан заголовок X-Api-Key |
| HTTP401 | КодINVALID_API_KEY |
ОписаниеПлатформа не знает переданную строку ключа |
| HTTP401 | КодTOKEN_MISSING |
ОписаниеКлюч приложения vibe_app_* передан без заголовка Authorization: Bearer с токеном сессии |
| HTTP401 | КодTOKEN_MISSING |
ОписаниеУ личного ключа vibe_api_* нет вебхука портала. Причина приходит в error.details |
| HTTP403 | КодSCOPE_DENIED |
ОписаниеКлючу не выдан скоуп landing |
| HTTP403 | КодWRITE_BLOCKED_READONLY_KEY |
ОписаниеКлюч запрещает запись |
Известные особенности
Битрикс24 автоматически пытается опубликовать созданный сайт. Передавайте в описании только сведения, предназначенные для публичного размещения.
Генерация забирает свободный черновик ИИ-сайта пользователя. Открытый чат ИИ-сайта теряет его и требует перезагрузки. Передавайте клиентский Idempotency-Key, чтобы повторно получить завершённый ответ в течение 24 часов. Параллельный повтор до сохранения ответа ключом не защищён. Без заголовка или с пустым либо пробельным заголовком каждый вызов запускает новую генерацию. Платформа автоматически не повторяет запуск.
Вызов выполняется от имени владельца вебхука или пользователя, чей токен OAuth использует ключ. Результат читайте через статус генерации: running, completed или failed.