For AI agents: markdown of this page — /docs-content-en/entities/sites/ai/status.md documentation index — /llms.txt

Get a generation status

GET /v1/sites/ai/status

Reads the current state of a generation started by the same user.

Parameters

Parameter Type Required Default Description
Parameterid (query) Typenumber Requiredyes Default— DescriptionGeneration identifier from start

Examples

curl — personal key

Terminal 
curl -X GET "https://vibecode.bitrix24.com/v1/sites/ai/status?id=11" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal 
curl -X GET "https://vibecode.bitrix24.com/v1/sites/ai/status?id=11" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — personal key

javascript 
const res = await fetch("https://vibecode.bitrix24.com/v1/sites/ai/status?id=11", {
  "method": "GET",
  "headers": {
    "X-Api-Key": "YOUR_API_KEY"
  }
});
const result = await res.json();
console.log(result);

JavaScript — OAuth application

javascript 
const res = await fetch("https://vibecode.bitrix24.com/v1/sites/ai/status?id=11", {
  "method": "GET",
  "headers": {
    "X-Api-Key": "YOUR_APP_KEY",
    "Authorization": "Bearer USER_SESSION_TOKEN"
  }
});
const result = await res.json();
console.log(result);

Response fields

Field Type Description
Fieldsuccess Typeboolean Descriptiontrue on success
Fielddata Typeobject DescriptionGeneration state
Fielddata.id Typenumber DescriptionGeneration identifier
Fielddata.status Typestring Descriptionrunning, completed or failed
Fielddata.siteId Typenumber DescriptionGenerated site identifier, 0 until created; sites
Fielddata.pageId Typenumber DescriptionGenerated page identifier, 0 until created; pages
Fielddata.draftSiteId Typenumber DescriptionDraft site identifier on failure, 0 otherwise
Fielddata.draftPageId Typenumber DescriptionDraft page identifier on failure, 0 otherwise
Fielddata.message Typestring DescriptionHuman-readable state; use status for branching
Fielddata.error Typestring | null DescriptionFailure reason or null
Fielddata.errorDetails Typestring | null DescriptionRequest-limit detail or null

Response example

JSON 
{
  "success": true,
  "data": {
    "id": 11,
    "status": "running",
    "siteId": 0,
    "pageId": 0,
    "draftSiteId": 0,
    "draftPageId": 0,
    "message": "Generating a site",
    "error": null,
    "errorDetails": null
  }
}

Error response example

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "The action could not be completed. Check the identifier",
    "b24Code": "LANDING_AI_SITE_GENERATION_NOT_FOUND"
  }
}

Errors

HTTP Code Description
HTTP400 CodeINVALID_PARAMS DescriptionBitrix24 refused the request
HTTP401 CodeMISSING_API_KEY, INVALID_API_KEY, TOKEN_MISSING DescriptionMissing or unusable credentials
HTTP403 CodeSCOPE_DENIED DescriptionThe key lacks the landing scope
HTTP403 CodeWRITE_BLOCKED_READONLY_KEY DescriptionThe key forbids writes
HTTP422 CodeBITRIX_ERROR DescriptionMissing generation or a generation of another user; b24Code is LANDING_AI_SITE_GENERATION_NOT_FOUND

Common errors.

Known specifics

Reading a completed or failed generation can make Bitrix24 finalize or release the draft binding and record a moderation refusal. Checking the status therefore requires write access; a READONLY key receives 403 WRITE_BLOCKED_READONLY_KEY. The platform does not retry a status request after a 5xx error.

Calls run as the webhook owner or the user whose OAuth token the key uses. Read the result through generation status: running, completed or failed.

See also