> ## 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/voices_save_preview ``` ## 身份验证和权限 在此请求头中发送 VoiceCheap API 密钥。也支持通过 Authorization: Bearer 发送同一 API 密钥。OAuth 访问令牌仅适用于 MCP，此 REST 端点不接受 OAuth 访问令牌。 所需权限: `voices:write`. 需要有效的付费订阅。权限不会改变团队角色、资源归属、媒体额度或套餐限制。 ## 参数 在传输层可选：如果省略，服务器会在验证前注入标识符。请自行提供稳定的 UUID v4，以便在响应丢失后安全恢复。 格式: "uuid". 匹配模式: `^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$`. 文本值。 格式: "uuid". 匹配模式: `^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$`. 文本值。 最小长度: 1. 最大长度: 80. 以下 JSON Schema 保留了发现接口公开的确切字段名、嵌套类型、默认值、范围和可接受值。其他跨字段规则列于操作说明中。 ```json theme={null} { "type": "object", "properties": { "requestId": { "description": "UUID v4 for this action. Reuse the same ID with identical arguments on retries.", "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$" }, "previewId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$" }, "name": { "type": "string", "minLength": 1, "maxLength": 80 } }, "required": ["previewId", "name"], "additionalProperties": false } ``` ## 幂等性 为每次修改操作在 requestId 或 Idempotency-Key HTTP 请求头中提供 UUID v4。网络故障后，请使用相同标识符和完全相同的参数重试。如果同时提供这两个值，它们必须一致。重放已保存的请求不会重复执行操作，也不会再次扣除月度调用次数。失败或中断的请求不会自动重新执行。 对于每次修改操作，如果重试时发现同一请求仍在运行，即使首次执行通常为同步操作，也可能返回 HTTP 202。如果执行已完成但 resultStored 为 false，重试会返回 HTTP 200 和已保存的请求状态，而非原始结果。请通过对应领域的历史记录、结果或下载操作获取输出。 ## 请求示例 请将示例资源标识符和媒体键替换为账户返回的值。重试同一次修改操作时，请保持请求标识符不变。 ```bash cURL theme={null} curl --request POST 'https://api.voicecheap.ai/v1/actions/voices_save_preview' \ --header "x-api-key: $VOICECHEAP_API_KEY" \ --header 'Content-Type: application/json' \ --data '{"requestId":"284a861a-4da8-4d67-ad48-8123e76c8e91","previewId":"44444444-4444-4444-8444-444444444444","name":"Studio narrator"}' ``` ```javascript JavaScript theme={null} const input = { requestId: '284a861a-4da8-4d67-ad48-8123e76c8e91', previewId: '44444444-4444-4444-8444-444444444444', name: 'Studio narrator', }; const response = await fetch('https://api.voicecheap.ai/v1/actions/voices_save_preview', { 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/voices_save_preview", headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]}, json={"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91", "previewId": "44444444-4444-4444-8444-444444444444", "name": "Studio narrator"}, timeout=120, ) body = response.json() if not response.ok: raise RuntimeError(f"{body.get('code')}: {body.get('message')}") print(body) ``` ## 响应 此操作在运行期间返回 HTTP 202。请保存 requestId，并使用该标识符和原始操作名称轮询 action\_request\_get。轮询状态包括 running、completed、failed 和 interrupted。已完成的结果可能指向独立的媒体任务；请继续使用该操作对应的状态或输出操作。 已保存的可复用 TTS 音色、更新后的已保存音色槽位限额，以及剩余的有效未保存预览和创建限额。 ```json HTTP 202 theme={null} { "data": { "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91", "status": "running", "pollAction": "action_request_get", "pollAfterSeconds": 5 }, "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91" } ``` ```json HTTP 200 theme={null} { "data": { "voicePreviews": [], "creationUsage": { "cloneTrial": { "limit": 1, "used": 1, "remaining": 0 }, "design": { "limit": 5, "used": 0, "remaining": 5, "resetsAt": 1792195200000 }, "previewExpiresAfterHours": 24 }, "voice": { "accent": "original", "id": "clone:44444444-4444-4444-8444-444444444444", "name": "Studio narrator", "previewUrl": "https://files.example.com/saved-narrator.mp3", "source": "clone" }, "cloneUsage": { "canClone": true, "limit": 10, "remaining": 9, "used": 1 } }, "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91" } ``` ```json HTTP 202 replay_running theme={null} { "data": { "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91", "operation": "voices_save_preview", "createdAt": 1792144800000, "updatedAt": 1792144820000, "status": "running", "pollAfterSeconds": 5 }, "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91" } ``` ```json HTTP 200 replay_completed_without_result theme={null} { "data": { "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91", "operation": "voices_save_preview", "createdAt": 1792144800000, "updatedAt": 1792144820000, "status": "completed", "resultStored": false, "message": "The action completed. Retrieve its output from the corresponding history or resource action." }, "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91" } ``` ## 结果字段 | 字段 | 说明 | | - | - | | `data.voicePreviews` | 此账户当前所有有效的未保存预览，包括先前请求中的候选音色。 | | `data.voicePreviews[].id` | 用于 voices\_preview\_get 和 voices\_save\_preview 的预览 UUID v4。 | | `data.voicePreviews[].kind` | clone 或 design。 | | `data.voicePreviews[].name` | 预览显示名称；设计的候选音色会在请求名称后追加编号。 | | `data.voicePreviews[].previewUrl` | 可播放的临时音频 URL。预览仍有效时，使用 voices\_preview\_get 请求新 URL。 | | `data.voicePreviews[].expiresAt` | 预览过期时间，以 Unix 毫秒时间戳表示。 | | `data.voicePreviews[].durationSeconds` | 预览音频时长，单位为秒。 | | `data.creationUsage.cloneTrial` | 终身克隆预览试用限额，包含 limit、used 和 remaining。 | | `data.creationUsage.design` | 每日音色设计限额，包含 limit、used、remaining，以及采用 Unix 毫秒时间戳的 resetsAt。 | | `data.creationUsage.previewExpiresAfterHours` | 未保存预览的有效期，以小时为单位，当前为 24。 | | `data.voice.id` | 可复用的 TTS 选择 ID 为 clone:\。tts\_generate 使用完整值，voices\_delete 仅使用 UUID。 | | `data.voice.name` | 已保存音色的显示名称。 | | `data.voice.accent` | 已保存的自定义音色使用 original。 | | `data.voice.source` | 已保存的自定义音色使用 clone。 | | `data.voice.previewUrl` | 已保存音色的临时音频预览 URL。 | | `data.cloneUsage.canClone` | 当前套餐是否允许保存自定义 TTS 音色；请检查 remaining 了解可用名额。 | | `data.cloneUsage.limit` | 套餐允许保存的自定义 TTS 音色槽位限额。 | | `data.cloneUsage.used` | 已占用的 TTS 音色名额，包括已预留的创建操作。 | | `data.cloneUsage.remaining` | 可用的已保存 TTS 音色槽位。 | ## 恢复并轮询此请求 即使连接丢失，也应使用同一标识符。如果 resultStored 为 false，请通过相应的历史记录、结果或下载操作获取输出。切勿仅为查看进度而启动第二次生成。 ```bash theme={null} curl --request POST 'https://api.voicecheap.ai/v1/actions/action_request_get' \ --header "x-api-key: $VOICECHEAP_API_KEY" \ --header 'Content-Type: application/json' \ --data '{"requestId":"284a861a-4da8-4d67-ad48-8123e76c8e91","operation":"voices_save_preview"}' ``` ```json HTTP 200 theme={null} { "data": { "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91", "operation": "voices_save_preview", "status": "completed", "createdAt": 1792144800000, "updatedAt": 1792144820000, "resultStored": true, "result": { "voicePreviews": [], "creationUsage": { "cloneTrial": { "limit": 1, "used": 1, "remaining": 0 }, "design": { "limit": 5, "used": 0, "remaining": 5, "resetsAt": 1792195200000 }, "previewExpiresAfterHours": 24 }, "voice": { "accent": "original", "id": "clone:44444444-4444-4444-8444-444444444444", "name": "Studio narrator", "previewUrl": "https://files.example.com/saved-narrator.mp3", "source": "clone" }, "cloneUsage": { "canClone": true, "limit": 10, "remaining": 9, "used": 1 } } } } ``` ## 操作说明 * 为此写入操作使用 UUID v4 格式的 requestId，重试时使用相同参数复用该 ID。长时间运行的操作首先返回 running 请求；此示例是可通过 action\_request\_get 获取的已完成处理程序结果。 * previewId 是 voices\_preview\_clone 或 voices\_design 返回的当前账户拥有的候选音色 UUID。name 去除首尾空白后包含 1–80 个字符。 * 保存需要付费套餐、可用的 TTS 已保存音色槽位，以及未过期且已就绪的预览。此操作适用于克隆和设计的候选音色。 * 可重复使用的选择 ID 为 clone:\。保存后的候选音色会从 voicePreviews 中消失；voices\_list 会将其列入已保存音色。 * 重复保存同一已保存候选项时，会复用已保存的音色。重复保存时会保留最初保存的名称。 * 若已保存的音色未出现在刷新的音色列表中，可能会省略 voice。请通过 voices\_list 获取当前已保存的音色。 * 语音历史记录和自定义音色归已认证账户所有。使用团队计费并不授予访问其他成员语音或音色的权限。 ## 用量 每次成功调用消耗一次月度 API/MCP 调用额度。媒体额度和操作本身的生成限额也适用。 ## 错误 | HTTP 状态 | 代码 | 含义或恢复方式 | | - | - | - | | 400 | `CREDENTIAL_IN_QUERY` | 凭证通过 access\_token 或 api\_key 查询参数提供。请在标头中发送凭证。 | | 400 | `IDEMPOTENCY_CONFLICT` | Idempotency-Key 请求头必须与请求体中的 requestId 字段一致。 | | 400 | `INVALID_REQUEST_ID` | 请在 requestId 或 Idempotency-Key 中提供 UUID v4。 | | 400 | `VALIDATION_ERROR` | 输入不符合操作架构；请查看 details 了解字段错误。 | | 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 | `ACCOUNT_UNAVAILABLE` | 调用者账户或计费账户不可用，或正在删除。 | | 403 | `AMBIGUOUS_TEAM_API_KEY` | 此凭据对应的用户属于多个团队，因此计费上下文不明确。 | | 403 | `INSUFFICIENT_SCOPE` | 请授予全部所需权限，或选择其他凭据。 | | 403 | `INTEGRATION_PLAN_UNSUPPORTED` | 无法验证该账户的集成限制。 | | 403 | `SUBSCRIPTION_REQUIRED` | 请使用有效的付费订阅。 | | 403 | `TEAM_OWNER_NOT_FOUND` | 找不到实际生效的团队所有者账户。 | | 403 | `VOICE_CLONING_REQUIRES_PAID_PLAN` | 当前套餐无法保存和重复使用自定义 TTS 音色。 | | 404 | `USER_NOT_FOUND` | 已认证账户已不存在。 | | 404 | `VOICE_PREVIEW_NOT_FOUND` | 预览不存在或属于其他账户。 | | 409 | `CONCURRENT_ACTION_LIMIT_REACHED` | 此账户已有 10 个集成操作正在运行。请先轮询现有请求，再启动另一个操作。 | | 409 | `IDEMPOTENCY_CONFLICT` | 只有操作和参数完全相同时，才能复用标识符。 | | 409 | `VOICE_CLONE_LIMIT_REACHED` | 所有可保存的自定义 TTS 音色名额均已占用。 | | 409 | `VOICE_CREATION_IN_PROGRESS` | 此候选音色仍在保存中，或账户删除流程阻止了新的音色操作。 | | 410 | `VOICE_PREVIEW_EXPIRED` | 候选音色已过期、尚未就绪或已无可用的预览音频。 | | 429 | `INTEGRATION_MONTHLY_LIMIT_REACHED` | 请等待月度额度重置，或更改套餐。 | | 429 | `INTEGRATION_RATE_LIMIT_REACHED` | 如果提供了 Retry-After，请等待其指定的时间，并采用退避重试。 | | 500 | `INTERNAL_ERROR` | 在决定是否重试修改操作前，请检查已保存的请求状态和资源历史记录。 | | 502 | `INTERNAL_ERROR` | 无法完成操作或确认其结果。启动另一次生成前，请检查请求状态和资源历史记录。 | | 503 | `ACTION_RESULT_UNAVAILABLE` | 操作已执行，但未能保存结果。在启动新的生成前，请检查已保存的请求状态和资源历史记录。 | | 503 | `SERVER_RESTARTING` | 服务器正在重启。请稍后重试；对于修改操作，请保持请求标识符不变。 | ```json theme={null} { "code": "INSUFFICIENT_SCOPE", "message": "This credential does not permit the requested action.", "status": 403, "details": { "requiredScopes": ["voices:write"] } } ``` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.