---
canonical_url: "https://docs.composio.dev/toolkits/gradium"
markdown_url: "https://docs.composio.dev/toolkits/gradium.md"
product: "platform"
version: null
last_updated: null
---

# Gradium

Gradium provides low-latency speech generation, transcription, voice management, and pronunciation tools for real-time voice applications.

- **Category:** audio & speech
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 9
- **Triggers:** 0
- **Slug:** `GRADIUM`
- **Version:** 20261014_00

## Tools

### Create Pronunciation Dictionary

**Slug:** `GRADIUM_CREATE_PRONUNCIATION_DICTIONARY`

Create a language-specific pronunciation dictionary with optional rewrite rules.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Human-readable dictionary name. |
| `rules` | array | No | Rewrite rules to include; each rule defaults to case-insensitive matching. |
| `language` | string | Yes | Language identifier for this dictionary. |
| `description` | string | No | Optional description of the dictionary's purpose. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Pronunciation Dictionary

**Slug:** `GRADIUM_DELETE_PRONUNCIATION_DICTIONARY`

Permanently delete one pronunciation dictionary by UID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `uid` | string | Yes | Opaque UID of the pronunciation dictionary to permanently delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Credits

**Slug:** `GRADIUM_GET_CREDITS`

Get the connected Gradium subscription's current credit balance and billing-period metadata.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Pronunciation Dictionary

**Slug:** `GRADIUM_GET_PRONUNCIATION_DICTIONARY`

Retrieve one pronunciation dictionary and its complete rewrite rule set by UID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `uid` | string | Yes | Opaque dictionary UID returned by a create or list call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Usage Summary

**Slug:** `GRADIUM_GET_USAGE_SUMMARY`

Retrieve aggregate Gradium session, message, text, audio-duration, and consumed-credit usage totals.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Voice

**Slug:** `GRADIUM_GET_VOICE`

Retrieve metadata for one Gradium catalog or custom voice by its UID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `voice_uid` | string | Yes | Voice UID returned by GRADIUM_LIST_VOICES. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Pronunciation Dictionaries

**Slug:** `GRADIUM_LIST_PRONUNCIATION_DICTIONARIES`

List pronunciation dictionaries for the connected organization, optionally filtered by language.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `language` | string | No | Only return dictionaries for this language identifier. |
| `page_size` | integer | No | Maximum dictionaries in this page (1-1000); sent as limit. |
| `next_cursor` | string | No | Continuation cursor from a previous call; preserve language when continuing. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Voices

**Slug:** `GRADIUM_LIST_VOICES`

List custom voices and, by default, Gradium's public voice catalog, returning voice IDs and metadata for later selection.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page_size` | integer | No | Maximum voices to return in this page; must be at least 1 and is sent as limit. |
| `next_cursor` | string | No | Continuation cursor from a previous call; preserve include_catalog when continuing. |
| `include_catalog` | boolean | No | Include Gradium's public catalog as well as custom voices. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Pronunciation Dictionary

**Slug:** `GRADIUM_UPDATE_PRONUNCIATION_DICTIONARY`

Update pronunciation dictionary metadata and optionally replace its complete rewrite rule set.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `uid` | string | Yes | Opaque UID of the dictionary to update. |
| `name` | string | No | New dictionary name; omit to leave unchanged. |
| `rules` | array | No | Complete intended replacement rule set. Pass an empty array to remove all rules, or omit this field to leave rules unchanged. |
| `language` | string | No | New language identifier; omit to leave unchanged. |
| `description` | string | No | New dictionary description; omit to leave unchanged. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |