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

List generation fields

GET /v1/sites/ai/fields

Lists field definitions for generation responses.

Parameters

Parameter Type Required Default Description
Parameterselect[] (query) Typearray RequiredNo DefaultAll properties DescriptionField definition properties, for example name, type, title. These are properties of each definition, not field names in the generation response

Examples

curl — personal key

Terminal 
curl -X GET "https://vibecode.bitrix24.com/v1/sites/ai/fields" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal 
curl -X GET "https://vibecode.bitrix24.com/v1/sites/ai/fields" \
  -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/fields", {
  "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/fields", {
  "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 Typearray DescriptionGeneration field definitions
Fielddata[].name Typestring DescriptionField name
Fielddata[].type Typestring DescriptionValue type
Fielddata[].title Typestring DescriptionField title
Fielddata[].description Typestring | null DescriptionField description or null
Fielddata[].validationRules Typearray DescriptionValidation rules
Fielddata[].requiredGroups Typearray | null DescriptionRequired groups or null
Fielddata[].filterable Typeboolean DescriptionCan be filtered
Fielddata[].sortable Typeboolean DescriptionCan be sorted
Fielddata[].editable Typeboolean DescriptionCan be edited
Fielddata[].editableGroups Typearray | null DescriptionEditing groups or null
Fielddata[].multiple Typeboolean DescriptionMultiple values
Fielddata[].elementType Typestring | null DescriptionElement type or null

Response example

JSON 
{
  "success": true,
  "data": [
    {
      "name": "id",
      "type": "int",
      "title": "Site generation identifier",
      "description": null,
      "validationRules": [],
      "requiredGroups": null,
      "filterable": false,
      "sortable": false,
      "editable": false,
      "editableGroups": null,
      "multiple": false,
      "elementType": null
    },
    {
      "name": "status",
      "type": "string",
      "title": "Generation status: running, completed or failed",
      "description": null,
      "validationRules": [],
      "requiredGroups": null,
      "filterable": false,
      "sortable": false,
      "editable": false,
      "editableGroups": null,
      "multiple": false,
      "elementType": null
    },
    {
      "name": "siteId",
      "type": "int",
      "title": "Generated site identifier, 0 until the site is created",
      "description": null,
      "validationRules": [],
      "requiredGroups": null,
      "filterable": false,
      "sortable": false,
      "editable": false,
      "editableGroups": null,
      "multiple": false,
      "elementType": null
    },
    {
      "name": "pageId",
      "type": "int",
      "title": "Generated page identifier, 0 until the page is created",
      "description": null,
      "validationRules": [],
      "requiredGroups": null,
      "filterable": false,
      "sortable": false,
      "editable": false,
      "editableGroups": null,
      "multiple": false,
      "elementType": null
    },
    {
      "name": "draftSiteId",
      "type": "int",
      "title": "Draft site identifier of a failed generation that got as far as creating one, 0 otherwise",
      "description": null,
      "validationRules": [],
      "requiredGroups": null,
      "filterable": false,
      "sortable": false,
      "editable": false,
      "editableGroups": null,
      "multiple": false,
      "elementType": null
    },
    {
      "name": "draftPageId",
      "type": "int",
      "title": "Draft page identifier of a failed generation that got as far as creating one, 0 otherwise",
      "description": null,
      "validationRules": [],
      "requiredGroups": null,
      "filterable": false,
      "sortable": false,
      "editable": false,
      "editableGroups": null,
      "multiple": false,
      "elementType": null
    },
    {
      "name": "message",
      "type": "string",
      "title": "Human readable generation state, a text for the user - branch on status, not on it",
      "description": null,
      "validationRules": [],
      "requiredGroups": null,
      "filterable": false,
      "sortable": false,
      "editable": false,
      "editableGroups": null,
      "multiple": false,
      "elementType": null
    },
    {
      "name": "error",
      "type": "string",
      "title": "Human readable failure reason, null unless the status is failed",
      "description": null,
      "validationRules": [],
      "requiredGroups": null,
      "filterable": false,
      "sortable": false,
      "editable": false,
      "editableGroups": null,
      "multiple": false,
      "elementType": null
    },
    {
      "name": "errorDetails",
      "type": "string",
      "title": "Exact wording of the request limit that stopped the generation, null when something else did",
      "description": null,
      "validationRules": [],
      "requiredGroups": null,
      "filterable": false,
      "sortable": false,
      "editable": false,
      "editableGroups": null,
      "multiple": false,
      "elementType": null
    }
  ]
}

Error response example

The request GET /v1/sites/ai/fields?select[]=FAKE_UNKNOWN_FIELD selects an unknown field definition property. Bitrix24 returns this error. An unknown field name in GET /v1/sites/ai/fields/FAKE_UNKNOWN_FIELD is a different case: it returns ENTITY_NOT_FOUND (404).

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "Unknown field `FAKE_UNKNOWN_FIELD` for entity `DtoFieldDto`",
    "b24Code": "BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION"
  }
}

Errors

HTTP Code Description
HTTP422 CodeBITRIX_ERROR 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

Common errors.

See also