> ## 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.

# 获取账户设置

> 获取已保存的词汇、翻译指令、音色和语言预设、收藏模板，以及个人界面偏好。

获取已保存的词汇、翻译指令、音色和语言预设、收藏模板，以及个人界面偏好。

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

## 身份验证和权限

<ParamField header="x-api-key" type="string" required>
  在此请求头中发送 VoiceCheap API 密钥。也支持通过 Authorization: Bearer 发送同一 API 密钥。OAuth 访问令牌仅适用于 MCP，此 REST 端点不接受 OAuth
  访问令牌。
</ParamField>

所需权限: `settings:read`.

需要有效的付费订阅。权限不会改变团队角色、资源归属、媒体额度或套餐限制。

## 参数

发送空 JSON 对象。此操作没有输入字段。

<Accordion title="完整输入架构">
  以下 JSON Schema 保留了发现接口公开的确切字段名、嵌套类型、默认值、范围和可接受值。其他跨字段规则列于操作说明中。

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

## 请求示例

请将示例资源标识符和媒体键替换为账户返回的值。重试同一次修改操作时，请保持请求标识符不变。

<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>

## 响应

首次执行成功时返回 HTTP 200，操作结果位于 data 下。重放请求时可能改为返回已保存的请求状态。示例展示了一种支持的响应，并未包含所有可选字段。

返回调用者的个人偏好设置，以及当前工作区所有者的共享词汇和翻译指令。

<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>

## 结果字段

| 字段 | 说明 |
| - | - |
| `data.companyName` | 个人公司名称，或 null。 |
| `data.brandVocabulary` | 工作区所有者的共享词汇；空数组表示没有。 |
| `data.customTranslationInstructions` | 账户共用的翻译指令；空字符串表示无指令。 |
| `data.canEditSharedSettings` | 调用者是否可以更改共享词汇和翻译指令。 |
| `data.favoriteTemplates` | 已保存的字幕和音色收藏，或 null。 |
| `data.favoriteTemplates.dynamicSubtitles` | 收藏的动态字幕模板名称，或 null。 |
| `data.favoriteTemplates.voiceIds` | 收藏的音色标识符。 |
| `data.targetLanguagePresets` | 已保存的个人语言预设。 |
| `data.targetLanguagePresets[].id` | 预设标识符。 |
| `data.targetLanguagePresets[].name` | 预设显示名称。 |
| `data.targetLanguagePresets[].languages` | 该预设中保存的语言。 |
| `data.socialMediaStatsPresets` | 已保存的个人频道选择。 |
| `data.socialMediaStatsPresets[].channelIds` | 该预设中保存的频道标识符。 |
| `data.textToSpeechBrandPresets` | 已保存的个人文本转语音表达预设。 |
| `data.textToSpeechBrandPresets[].voice` | 已保存的音色选择标识符。 |
| `data.textToSpeechBrandPresets[].instructionPreset` | 已保存的表达预设名称。 |
| `data.textToSpeechBrandPresets[].instructions` | 已保存的表达指令。 |
| `data.textToSpeechBrandPresets[].speed` | 已保存的语速倍数。 |
| `data.defaultVoiceCloningSettings` | 默认 stability 和 similarity 值，或 null。 |
| `data.isSoundNotificationsEnabled` | 个人声音通知偏好。 |
| `data.isVoiceCloningSettingsTipDismissed` | 调用者是否已关闭音色设置提示。 |

## 操作说明

* 账户为团队成员时，共享设置来自团队所有者，界面偏好设置则仍归个人。

## 用量

每次成功调用消耗一次月度 API/MCP 调用额度。媒体额度和操作本身的生成限额也适用。

## 错误

| HTTP 状态 | 代码 | 含义或恢复方式 |
| - | - | - |
| 400 | `CREDENTIAL_IN_QUERY` | 凭证通过 access\_token 或 api\_key 查询参数提供。请在标头中发送凭证。 |
| 400 | `VALIDATION_ERROR` | JSON 对象包含不受支持的字段、无效值，或缺少必需参数。 |
| 401 | `API_KEY_EXPIRED` | API 密钥已过期。 |
| 401 | `INVALID_API_KEY` | 请提供有效且未过期的 API 密钥。 |
| 401 | `INVALID_CREDENTIAL` | Authorization 标头格式错误或与 x-api-key 冲突。 |
| 401 | `MISSING_CREDENTIAL` | 未提供可用的请求头凭据，或其长度超过 4096 个字符。 |
| 401 | `USER_NOT_FOUND` | 该凭据对应的账户已不存在。 |
| 403 | `AMBIGUOUS_TEAM_API_KEY` | 此凭据对应的用户属于多个团队，因此计费上下文不明确。 |
| 403 | `INSUFFICIENT_SCOPE` | 请授予全部所需权限，或选择其他凭据。 |
| 403 | `INTEGRATION_PLAN_UNSUPPORTED` | 无法验证该账户的集成限制。 |
| 403 | `SUBSCRIPTION_REQUIRED` | 请使用有效的付费订阅。 |
| 403 | `TEAM_MEMBERSHIP_INVALID` | 账户当前的团队成员关系与此连接的工作区不匹配。请刷新成员关系并重新连接。 |
| 403 | `TEAM_OWNER_NOT_FOUND` | 找不到实际生效的团队所有者账户。 |
| 404 | `ACCOUNT_NOT_FOUND` | 找不到账户或当前工作区账户。 |
| 429 | `INTEGRATION_MONTHLY_LIMIT_REACHED` | 请等待月度额度重置，或更改套餐。 |
| 429 | `INTEGRATION_RATE_LIMIT_REACHED` | 如果提供了 Retry-After，请等待其指定的时间，并采用退避重试。 |
| 500 | `INTERNAL_ERROR` | 在决定是否重试修改操作前，请检查已保存的请求状态和资源历史记录。 |
| 503 | `SERVER_RESTARTING` | 服务器正在重启。请稍后重试；对于修改操作，请保持请求标识符不变。 |

```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.