## 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](/docs/chats/files/transcribe) 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

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

### curl — OAuth application

```bash
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 |
|------|-----|---------|
| `success` | boolean | Always `true` on success |
| `data.protocol` | number | Transcription protocol version. Always `1` |
| `data.available.audio` | boolean | Whether transcription of audio files is available |
| `data.available.videoNote` | boolean | Whether transcription of video notes is available |
| `data.limits.maxBytes` | number | Maximum file size for transcription, in bytes. A positive integer |
| `data.limits.maxChars` | number | Maximum transcript length, in characters. A positive integer |
| `data.maxWaitMs` | number | Maximum 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 |
|------|-----|---------|
| 400 | `INVALID_PARAMS` | A query string parameter was passed — the method takes no parameters. Checked before any Bitrix24 call |
| 422 | `BITRIX_ERROR` | `error.b24Code` = `TRANSCRIPTION_NOT_ACTIVE` — the Bitrix24 account did not return transcription settings or returned them in an unsupported form |
| 404 | `ENTITY_NOT_FOUND` | Bitrix24 returned a "not found" error. The Bitrix24 code is in `error.b24Code` |
| 422 | `BITRIX_ERROR` | Bitrix24 refused the settings request. The Bitrix24 code is in `error.b24Code` |
| 403 | `SCOPE_DENIED` | The API key lacks the `im` scope |
| 403 | `WRITE_BLOCKED_READONLY_KEY` | The key is read-only — the call may create system folders on the Bitrix24 account. Checked before any Bitrix24 call |
| 401 | `TOKEN_MISSING` | The API key has no Bitrix24 tokens configured |

The full list of general API errors — [Errors](/docs/errors).

## See also

- [Transcribe an audio file](/docs/chats/files/transcribe)
- [Chat files](/docs/chats/files)