For AI agents: markdown of this page — /docs-content-en/chats/files/transcribe-transcription-config.md documentation index — /llms.txt

Get transcription settings

GET /v1/chats/transcription/config

Returns the speech transcription settings of the Bitrix24 account: which files can be transcribed, the maximum file size and the maximum transcript length.

Call this method before transcribing an audio file with the requestId and contentVersion pair: send the pair only if this method returned a successful response. Transcription without the pair does not require this method.

Examples

curl — personal key

Terminal 
curl -X GET https://vibecode.bitrix24.com/v1/chats/transcription/config \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal 
curl -X GET https://vibecode.bitrix24.com/v1/chats/transcription/config \
  -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/chats/transcription/config', {
  method: 'GET',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('Audio:', data.available.audio, 'Video notes:', data.available.videoNote)

JavaScript — OAuth application

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/chats/transcription/config', {
  method: 'GET',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { success, data } = await res.json()
console.log('Audio:', data.available.audio, 'Video notes:', data.available.videoNote)

Response fields

Field Type Description
Fieldsuccess Typeboolean DescriptionAlways true on success
Fielddata.protocol Typenumber DescriptionTranscription protocol version. Always 1
Fielddata.available.audio Typeboolean DescriptionWhether transcription of audio files is available
Fielddata.available.videoNote Typeboolean DescriptionWhether transcription of video notes is available
Fielddata.limits.maxBytes Typenumber DescriptionMaximum file size for transcription, in bytes. A positive integer
Fielddata.limits.maxChars Typenumber DescriptionMaximum transcript length, in characters. A positive integer
Fielddata.maxWaitMs Typenumber DescriptionMaximum time to wait for the result, in milliseconds. Always 300000

Response example

JSON 
{
  "success": true,
  "data": {
    "protocol": 1,
    "available": {
      "audio": true,
      "videoNote": false
    },
    "limits": {
      "maxBytes": 26214400,
      "maxChars": 20000
    },
    "maxWaitMs": 300000
  }
}

Error response example

422 — the Bitrix24 account did not return transcription settings:

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "Media transcription is unavailable.",
    "b24Code": "TRANSCRIPTION_NOT_ACTIVE"
  }
}

Errors

HTTP Code Description
HTTP400 CodeINVALID_PARAMS DescriptionA query string parameter was passed — the method takes no parameters. Checked before any Bitrix24 call
HTTP422 CodeBITRIX_ERROR Descriptionerror.b24Code = TRANSCRIPTION_NOT_ACTIVE — the Bitrix24 account did not return transcription settings or returned them in an unsupported form
HTTP404 CodeENTITY_NOT_FOUND DescriptionBitrix24 returned a "not found" error. The Bitrix24 code is in error.b24Code
HTTP422 CodeBITRIX_ERROR DescriptionBitrix24 refused the settings request. The Bitrix24 code is in error.b24Code
HTTP403 CodeSCOPE_DENIED DescriptionThe API key lacks the im scope
HTTP403 CodeWRITE_BLOCKED_READONLY_KEY DescriptionThe key is read-only — the call may create system folders on the Bitrix24 account. Checked before any Bitrix24 call
HTTP401 CodeTOKEN_MISSING DescriptionThe API key has no Bitrix24 tokens configured

The full list of general API errors — Errors.

See also