> ## 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/account_get
```

## 身份验证和权限

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

所需权限: `account: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/account_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/account_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/account_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": {
      "userId": "user_123",
      "email": "developer@example.com",
      "displayName": "Studio owner",
      "companyName": "Studio",
      "plan": "pro",
      "workspace": {
        "ownerUserId": "user_123",
        "teamId": null,
        "isTeamMember": false
      },
      "credits": {
        "availableMinutes": 150,
        "includedMinutes": 120,
        "purchasedMinutes": 30,
        "textToSpeech": {
          "limit": 4000000,
          "used": 125000,
          "remaining": 3925000,
          "includedRemaining": 3875000,
          "purchasedRemaining": 50000,
          "resetsAt": 1793491200000
        }
      },
      "permissions": {
        "scopes": [
          "account:read"
        ],
        "canManageOwnTeam": false,
        "canEditSharedSettings": true
      },
      "limits": {
        "maxConcurrentTranslations": 5,
        "accessToLipSyncPro": false
      }
    }
  }
  ```
</ResponseExample>

## 结果字段

| 字段 | 说明 |
| - | - |
| `data.userId` | 通过身份验证的账户标识符。 |
| `data.email` | 已认证账户的电子邮件地址。 |
| `data.displayName` | 已认证账户的显示名称。 |
| `data.companyName` | 已保存的公司名称，或 null。 |
| `data.plan` | 此连接使用的有效套餐。 |
| `data.workspace.ownerUserId` | 拥有当前工作区内项目和分钟额度的账户。 |
| `data.workspace.teamId` | 当前团队标识符；个人工作区则为 null。 |
| `data.workspace.isTeamMember` | 此连接是否以成员身份在团队所有者的工作区中操作。 |
| `data.credits.availableMinutes` | 可用的完整分钟总数，包含已购买额度。 |
| `data.credits.includedMinutes` | 套餐内余额中的可用整分钟数。 |
| `data.credits.purchasedMinutes` | 已购买分钟额度中可用的完整分钟数。 |
| `data.credits.textToSpeech.limit` | 当前额度周期内套餐包含的文本转语音字符限额。 |
| `data.credits.textToSpeech.used` | 当前周期内已使用的套餐内文本转语音字符数。 |
| `data.credits.textToSpeech.remaining` | 可用的文本转语音字符数，包含套餐内字符和已购买字符。 |
| `data.credits.textToSpeech.includedRemaining` | 可用的套餐内文本转语音字符数。 |
| `data.credits.textToSpeech.purchasedRemaining` | 可用的已购买文本转语音字符数。 |
| `data.credits.textToSpeech.resetsAt` | 当前文本转语音额度周期的结束时间，单位为毫秒；无有效周期时为 null。 |
| `data.permissions.scopes` | 授予此 API 密钥或 MCP 连接的权限。 |
| `data.permissions.canManageOwnTeam` | 已通过身份验证的账户是否已拥有团队。 |
| `data.permissions.canEditSharedSettings` | 调用者是否可以编辑工作区词汇和账户翻译指令。 |
| `data.limits.maxConcurrentTranslations` | 实际生效的翻译并发限额。 |
| `data.limits.accessToLipSyncPro` | 此连接实际生效的账户是否有权使用 Pro 口型同步。 |

## 操作说明

* 分钟额度属于当前个人或团队工作区。文本转语音历史记录和字符额度属于已认证账户。
* 文本转语音限额周期从上一周期结束后的首次生成开始，持续 30 天；其重置独立于按自然月计算的集成调用。
* 此操作不返回已保存的 API 密钥、Webhook 签名密钥或外部账户凭据。

## 用量

每次成功调用消耗一次月度 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": ["account:read"]
  }
}
```


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