> ## Documentation Index
> Fetch the complete documentation index at: https://api-docs.voicecheap.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Get account settings

> Get saved vocabulary, translation instructions, voice and language presets, favorite templates, and personal interface preferences.

Get saved vocabulary, translation instructions, voice and language presets, favorite templates, and personal interface preferences.

```http theme={null}
POST https://api.voicecheap.ai/v1/actions/settings_get
```

## Authentication and permissions

<ParamField header="x-api-key" type="string" required>
  Send a VoiceCheap API key in this header. Authorization: Bearer with the same API key is also supported. OAuth access tokens are accepted only by
  MCP, not by this REST endpoint.
</ParamField>

Required permissions: `settings:read`.

An active paid subscription is required. Permissions do not change team roles, resource ownership, media credits, or plan limits.

## Parameters

Send an empty JSON object. This action has no input fields.

<Accordion title="Complete input schema">
  The JSON Schema below preserves the exact field names, nested types, defaults, bounds, and accepted values exposed by discovery. Additional cross-field rules are listed in the operation notes.

  ```json theme={null}
  {
    "type": "object",
    "properties": {},
    "additionalProperties": false
  }
  ```
</Accordion>

## Request examples

Replace example resource identifiers and media keys with values returned for your account. Keep the request identifier stable when retrying the same mutation.

<RequestExample>
  ```bash cURL theme={null}
  curl --request POST 'https://api.voicecheap.ai/v1/actions/settings_get' \
    --header "x-api-key: $VOICECHEAP_API_KEY" \
    --header 'Content-Type: application/json' \
    --data '{}'
  ```

  ```javascript JavaScript theme={null}
  const input = {};
  const response = await fetch('https://api.voicecheap.ai/v1/actions/settings_get', {
    method: 'POST',
    headers: {
      'x-api-key': process.env.VOICECHEAP_API_KEY,
      'Content-Type': 'application/json',
    },
    body: JSON.stringify(input),
  });
  const body = await response.json();
  if (!response.ok) throw new Error(body.code + ': ' + body.message);
  console.log(body);
  ```

  ```python Python theme={null}
  import os
  import requests

  response = requests.post(
      "https://api.voicecheap.ai/v1/actions/settings_get",
      headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
      json={},
      timeout=120,
  )
  body = response.json()
  if not response.ok:
      raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
  print(body)
  ```
</RequestExample>

## Response

A successful first execution returns HTTP 200 with the operation result under data. A replay may return saved request state instead. The example shows one supported response, not every optional field.

Returns the caller’s personal preferences and the active workspace owner’s shared vocabulary and translation instructions.

<ResponseExample>
  ```json HTTP 200 theme={null}
  {
    "data": {
      "companyName": "Studio",
      "brandVocabulary": [
        "VoiceCheap"
      ],
      "customTranslationInstructions": "Keep product names unchanged.",
      "canEditSharedSettings": true,
      "favoriteTemplates": {
        "dynamicSubtitles": null,
        "voiceIds": []
      },
      "targetLanguagePresets": [
        {
          "id": "european_languages",
          "name": "European languages",
          "languages": [
            "french",
            "german"
          ]
        }
      ],
      "socialMediaStatsPresets": [],
      "textToSpeechBrandPresets": [],
      "defaultVoiceCloningSettings": {
        "stability": 0.5,
        "similarity": 0.75
      },
      "isSoundNotificationsEnabled": true,
      "isVoiceCloningSettingsTipDismissed": false
    }
  }
  ```
</ResponseExample>

## Result fields

| Field | Description |
| - | - |
| `data.companyName` | Personal company name, or null. |
| `data.brandVocabulary` | Shared vocabulary from the workspace owner; an empty array means none. |
| `data.customTranslationInstructions` | Shared account translation instructions; an empty string means none. |
| `data.canEditSharedSettings` | Whether the caller may change shared vocabulary and translation instructions. |
| `data.favoriteTemplates` | Saved subtitle and voice favorites, or null. |
| `data.favoriteTemplates.dynamicSubtitles` | Favorite dynamic subtitle template name, or null. |
| `data.favoriteTemplates.voiceIds` | Favorite voice identifiers. |
| `data.targetLanguagePresets` | Saved personal language presets. |
| `data.targetLanguagePresets[].id` | Preset identifier. |
| `data.targetLanguagePresets[].name` | Preset display name. |
| `data.targetLanguagePresets[].languages` | Languages saved in that preset. |
| `data.socialMediaStatsPresets` | Saved personal channel selections. |
| `data.socialMediaStatsPresets[].channelIds` | Channel identifiers saved in that preset. |
| `data.textToSpeechBrandPresets` | Saved personal text-to-speech delivery presets. |
| `data.textToSpeechBrandPresets[].voice` | Saved voice selection identifier. |
| `data.textToSpeechBrandPresets[].instructionPreset` | Saved delivery preset name. |
| `data.textToSpeechBrandPresets[].instructions` | Saved delivery instructions. |
| `data.textToSpeechBrandPresets[].speed` | Saved speaking-speed multiplier. |
| `data.defaultVoiceCloningSettings` | Default stability and similarity values, or null. |
| `data.isSoundNotificationsEnabled` | Personal sound notification preference. |
| `data.isVoiceCloningSettingsTipDismissed` | Whether the caller dismissed the voice settings tip. |

## Operation notes

* When the account is a team member, shared settings come from the team owner while interface preferences remain personal.

## Usage

Each successful invocation consumes one monthly API/MCP call. Media credits and the operation's own generation allowances also apply.

## Errors

| HTTP status | Code | Meaning or recovery |
| - | - | - |
| 400 | `CREDENTIAL_IN_QUERY` | Credentials were supplied in an access\_token or api\_key query parameter. Send credentials in headers. |
| 400 | `VALIDATION_ERROR` | The JSON object contains an unsupported field, an invalid value, or a missing required argument. |
| 401 | `API_KEY_EXPIRED` | The API key has expired. |
| 401 | `INVALID_API_KEY` | Provide a valid, unexpired API key. |
| 401 | `INVALID_CREDENTIAL` | The Authorization header is malformed or conflicts with x-api-key. |
| 401 | `MISSING_CREDENTIAL` | No usable header credential was supplied, or it exceeded 4096 characters. |
| 401 | `USER_NOT_FOUND` | The credential's account no longer exists. |
| 403 | `AMBIGUOUS_TEAM_API_KEY` | The credential's user belongs to more than one team, so the billing context is ambiguous. |
| 403 | `INSUFFICIENT_SCOPE` | Grant every required permission or choose another credential. |
| 403 | `INTEGRATION_PLAN_UNSUPPORTED` | The account's integration limits could not be verified. |
| 403 | `SUBSCRIPTION_REQUIRED` | Use an active paid subscription. |
| 403 | `TEAM_MEMBERSHIP_INVALID` | The account’s current team membership does not match this connection’s workspace. Refresh the membership and reconnect. |
| 403 | `TEAM_OWNER_NOT_FOUND` | The effective team owner account could not be found. |
| 404 | `ACCOUNT_NOT_FOUND` | The account or active workspace account could not be found. |
| 429 | `INTEGRATION_MONTHLY_LIMIT_REACHED` | Wait for the monthly reset or change plan. |
| 429 | `INTEGRATION_RATE_LIMIT_REACHED` | Wait for Retry-After when present and use backoff. |
| 500 | `INTERNAL_ERROR` | Check saved request state and resource history before deciding to retry a mutation. |
| 503 | `SERVER_RESTARTING` | The server is restarting. Retry shortly and keep the same request identifier for a mutation. |

```json theme={null}
{
  "code": "INSUFFICIENT_SCOPE",
  "message": "This credential does not permit the requested action.",
  "status": 403,
  "details": {
    "requiredScopes": ["settings:read"]
  }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.