curl --request POST 'https://api.voicecheap.ai/v1/actions/voices_design' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"requestId":"284a861a-4da8-4d67-ad48-8123e76c8e91","name":"Studio narrator","description":"A warm, clear English narrator with steady pacing and a natural conversational delivery.","language":"en"}'
const input = {
requestId: '284a861a-4da8-4d67-ad48-8123e76c8e91',
name: 'Studio narrator',
description: 'A warm, clear English narrator with steady pacing and a natural conversational delivery.',
language: 'en',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/voices_design', {
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);
import os
import requests
response = requests.post(
"https://api.voicecheap.ai/v1/actions/voices_design",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91", "name": "Studio narrator", "description": "A warm, clear English narrator with steady pacing and a natural conversational delivery.", "language": "en"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
"status": "running",
"pollAction": "action_request_get",
"pollAfterSeconds": 5
},
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91"
}
{
"data": {
"voicePreviews": [
{
"id": "44444444-4444-4444-8444-444444444444",
"kind": "design",
"name": "Studio narrator 1",
"previewUrl": "https://files.example.com/designed-narrator-1.wav",
"expiresAt": 1792238400000,
"durationSeconds": 8
},
{
"id": "55555555-5555-4555-8555-555555555555",
"kind": "design",
"name": "Studio narrator 2",
"previewUrl": "https://files.example.com/designed-narrator-2.wav",
"expiresAt": 1792238400000,
"durationSeconds": 9
}
],
"creationUsage": {
"cloneTrial": {
"limit": 1,
"used": 0,
"remaining": 1
},
"design": {
"limit": 5,
"used": 1,
"remaining": 4,
"resetsAt": 1792195200000
},
"previewExpiresAfterHours": 24
}
},
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91"
}
{
"data": {
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
"operation": "voices_design",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91"
}
{
"data": {
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
"operation": "voices_design",
"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"
}
음성 합성용 음성
음성 디자인
음성 디자인 허용량을 사용하여 설명으로 음성 후보를 생성합니다. voices_preview_get으로 들어본 후 선택한 미리 보기를 저장하세요.
POST
/
v1
/
actions
/
voices_design
curl --request POST 'https://api.voicecheap.ai/v1/actions/voices_design' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"requestId":"284a861a-4da8-4d67-ad48-8123e76c8e91","name":"Studio narrator","description":"A warm, clear English narrator with steady pacing and a natural conversational delivery.","language":"en"}'
const input = {
requestId: '284a861a-4da8-4d67-ad48-8123e76c8e91',
name: 'Studio narrator',
description: 'A warm, clear English narrator with steady pacing and a natural conversational delivery.',
language: 'en',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/voices_design', {
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);
import os
import requests
response = requests.post(
"https://api.voicecheap.ai/v1/actions/voices_design",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91", "name": "Studio narrator", "description": "A warm, clear English narrator with steady pacing and a natural conversational delivery.", "language": "en"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
"status": "running",
"pollAction": "action_request_get",
"pollAfterSeconds": 5
},
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91"
}
{
"data": {
"voicePreviews": [
{
"id": "44444444-4444-4444-8444-444444444444",
"kind": "design",
"name": "Studio narrator 1",
"previewUrl": "https://files.example.com/designed-narrator-1.wav",
"expiresAt": 1792238400000,
"durationSeconds": 8
},
{
"id": "55555555-5555-4555-8555-555555555555",
"kind": "design",
"name": "Studio narrator 2",
"previewUrl": "https://files.example.com/designed-narrator-2.wav",
"expiresAt": 1792238400000,
"durationSeconds": 9
}
],
"creationUsage": {
"cloneTrial": {
"limit": 1,
"used": 0,
"remaining": 1
},
"design": {
"limit": 5,
"used": 1,
"remaining": 4,
"resetsAt": 1792195200000
},
"previewExpiresAfterHours": 24
}
},
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91"
}
{
"data": {
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
"operation": "voices_design",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91"
}
{
"data": {
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
"operation": "voices_design",
"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"
}
음성 디자인 허용량을 사용하여 설명으로 음성 후보를 생성합니다. voices_preview_get으로 들어본 후 선택한 미리 보기를 저장하세요.
필요한 권한:
POST https://api.voicecheap.ai/v1/actions/voices_design
인증 및 권한
string
필수
이 헤더에 VoiceCheap API 키를 전달하세요. 동일한 API 키를 사용하는 Authorization: Bearer도 지원합니다. OAuth 액세스 토큰은 MCP에서만 허용되며, 이
REST 엔드포인트에서는 사용할 수 없습니다.
voices:write.
활성 유료 구독이 필요합니다. 권한은 팀 역할, 리소스 소유권, 미디어 크레딧 또는 요금제 한도를 변경하지 않습니다.
매개변수
string
전송 계층에서는 선택 사항입니다. 생략하면 서버가 유효성 검사 전에 식별자를 추가합니다. 응답이 유실된 경우 안전하게 복구할 수 있도록 고정된 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}$.string
필수
텍스트 값입니다.최소 길이: 1. 최대 길이: 80.
string
필수
텍스트 값입니다.최소 길이: 1. 최대 길이: 2000.
string
텍스트 값입니다.최대 길이: 35. 패턴:
^[a-z]{2,3}(-[A-Za-z0-9]{2,8})*$.전체 입력 스키마
전체 입력 스키마
아래 JSON Schema는 검색을 통해 제공되는 정확한 필드 이름, 중첩 유형, 기본값, 범위 및 허용값을 유지합니다. 추가적인 필드 간 규칙은 작업 참고 사항에 나와 있습니다.
{
"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}$"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 80
},
"description": {
"type": "string",
"minLength": 1,
"maxLength": 2000
},
"language": {
"type": "string",
"maxLength": 35,
"pattern": "^[a-z]{2,3}(-[A-Za-z0-9]{2,8})*$"
}
},
"required": ["name", "description"],
"additionalProperties": false
}
멱등성
각 변경 작업에 대해 requestId 또는 Idempotency-Key HTTP 헤더에 UUID v4를 사용하세요. 네트워크 오류 후에는 동일한 식별자와 동일한 인수를 재사용하세요. 둘 다 제공하는 경우 값이 일치해야 합니다. 저장된 요청을 재전송해도 작업이 반복되거나 월간 호출이 추가로 차감되지 않습니다. 실패하거나 중단된 요청은 자동으로 다시 시작되지 않습니다. 첫 실행이 일반적으로 동기식인 경우에도, 재시도 시 동일한 요청이 아직 실행 중이면 모든 변경 작업에서 HTTP 202를 반환할 수 있습니다. 실행은 완료되었지만 resultStored가 false이면, 재시도 시 원래 결과 대신 저장된 요청 상태를 HTTP 200으로 반환합니다. 해당 영역의 기록, 결과 또는 다운로드 액션으로 출력을 조회하세요.요청 예제
예제의 리소스 식별자와 미디어 키를 계정에서 반환된 값으로 바꾸세요. 동일한 변경 작업을 재시도할 때는 요청 식별자를 유지하세요.curl --request POST 'https://api.voicecheap.ai/v1/actions/voices_design' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"requestId":"284a861a-4da8-4d67-ad48-8123e76c8e91","name":"Studio narrator","description":"A warm, clear English narrator with steady pacing and a natural conversational delivery.","language":"en"}'
const input = {
requestId: '284a861a-4da8-4d67-ad48-8123e76c8e91',
name: 'Studio narrator',
description: 'A warm, clear English narrator with steady pacing and a natural conversational delivery.',
language: 'en',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/voices_design', {
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);
import os
import requests
response = requests.post(
"https://api.voicecheap.ai/v1/actions/voices_design",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91", "name": "Studio narrator", "description": "A warm, clear English narrator with steady pacing and a natural conversational delivery.", "language": "en"},
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입니다. 완료된 결과가 별도의 미디어 작업을 가리킬 수 있으므로 해당 작업의 상태 또는 출력 액션을 이어서 사용하세요. 새로 디자인된 음성 후보 두 개를 포함한 모든 활성 미저장 미리보기와 갱신된 생성 허용량입니다.{
"data": {
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
"status": "running",
"pollAction": "action_request_get",
"pollAfterSeconds": 5
},
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91"
}
{
"data": {
"voicePreviews": [
{
"id": "44444444-4444-4444-8444-444444444444",
"kind": "design",
"name": "Studio narrator 1",
"previewUrl": "https://files.example.com/designed-narrator-1.wav",
"expiresAt": 1792238400000,
"durationSeconds": 8
},
{
"id": "55555555-5555-4555-8555-555555555555",
"kind": "design",
"name": "Studio narrator 2",
"previewUrl": "https://files.example.com/designed-narrator-2.wav",
"expiresAt": 1792238400000,
"durationSeconds": 9
}
],
"creationUsage": {
"cloneTrial": {
"limit": 1,
"used": 0,
"remaining": 1
},
"design": {
"limit": 5,
"used": 1,
"remaining": 4,
"resetsAt": 1792195200000
},
"previewExpiresAfterHours": 24
}
},
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91"
}
{
"data": {
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
"operation": "voices_design",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91"
}
{
"data": {
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
"operation": "voices_design",
"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입니다. |
이 요청 복구 및 폴링
연결이 끊어진 후에도 동일한 식별자를 사용하세요. resultStored가 false이면 해당 기록, 결과 또는 다운로드 액션을 통해 출력을 조회하세요. 진행 상황을 확인하기 위해 두 번째 생성을 시작하지 마세요.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_design"}'
HTTP 200
{
"data": {
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
"operation": "voices_design",
"status": "completed",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"resultStored": true,
"result": {
"voicePreviews": [
{
"id": "44444444-4444-4444-8444-444444444444",
"kind": "design",
"name": "Studio narrator 1",
"previewUrl": "https://files.example.com/designed-narrator-1.wav",
"expiresAt": 1792238400000,
"durationSeconds": 8
},
{
"id": "55555555-5555-4555-8555-555555555555",
"kind": "design",
"name": "Studio narrator 2",
"previewUrl": "https://files.example.com/designed-narrator-2.wav",
"expiresAt": 1792238400000,
"durationSeconds": 9
}
],
"creationUsage": {
"cloneTrial": {
"limit": 1,
"used": 0,
"remaining": 1
},
"design": {
"limit": 5,
"used": 1,
"remaining": 4,
"resetsAt": 1792195200000
},
"previewExpiresAfterHours": 24
}
}
}
}
작업 참고 사항
- 이 변경 작업에 UUID v4 requestId를 사용하고 재시도 시 동일한 인수와 함께 재사용하세요. 장시간 실행되는 액션은 먼저 running 요청을 반환합니다. 이 예시는 action_request_get에서 얻을 수 있는 완료된 핸들러 결과입니다.
- name은 앞뒤 공백을 제거한 후 1–80자여야 합니다. description은 앞뒤 공백을 제거한 후 1–2,000자여야 합니다. 선택 사항인 language는 선택적 하위 태그를 포함할 수 있는 2–3자 알파벳 코드를 허용하며 최대 35자입니다.
- 디자인 요청에 성공하면 번호가 붙은 이름을 가진 kind: design 후보 두 개를 생성하고 일일 디자인 요청 한 번을 사용합니다. 유료 요금제에는 UTC 기준 일일 요청 다섯 번이 허용됩니다. 현재 횟수와 초기화 시각은 creationUsage.design을 확인하세요.
- 후보는 24시간 동안 유지되며, 저장된 재사용 가능 TTS 음성이 아닙니다. voices_preview_get으로 들어본 다음 voices_save_preview로 선택한 후보를 저장하세요.
- 응답에는 새 후보뿐 아니라 이전의 활성 미리보기도 포함됩니다. 후보를 저장하기 전까지는 저장 음성 슬롯을 차지하지 않습니다.
- 음성 합성 기록과 사용자 지정 음성은 인증된 계정에 속합니다. 팀 결제를 사용해도 다른 멤버의 음성 합성 결과나 음성에 접근할 수 없습니다.
사용량
성공한 호출마다 월간 API/MCP 호출 1회가 차감됩니다. 미디어 크레딧과 해당 작업의 생성 허용량도 적용됩니다.오류
| HTTP 상태 | 코드 | 의미 또는 복구 방법 |
|---|---|---|
| 400 | CREDENTIAL_IN_QUERY | 자격 증명이 access_token 또는 api_key 쿼리 매개변수로 제공되었습니다. 자격 증명은 헤더로 보내세요. |
| 400 | IDEMPOTENCY_CONFLICT | Idempotency-Key 헤더와 본문의 requestId 필드가 일치해야 합니다. |
| 400 | INVALID_REQUEST_ID | UUID v4인 requestId 또는 Idempotency-Key를 제공하세요. |
| 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 | 실제로 적용되는 팀 소유자 계정을 찾을 수 없습니다. |
| 404 | USER_NOT_FOUND | 인증된 계정이 더 이상 존재하지 않습니다. |
| 404 | VOICE_PREVIEW_NOT_FOUND | 요청이 다른 계정에 속합니다. |
| 409 | CONCURRENT_ACTION_LIMIT_REACHED | 이 계정에서는 이미 10개의 연동 액션이 실행 중입니다. 새 액션을 시작하기 전에 기존 요청을 폴링하세요. |
| 409 | IDEMPOTENCY_CONFLICT | 동일한 작업과 인수에 대해서만 식별자를 재사용하세요. |
| 409 | VOICE_CREATION_IN_PROGRESS | 미리보기를 아직 생성 중이거나 계정 삭제로 인해 새 음성 작업이 차단되었습니다. |
| 409 | VOICE_CREATION_REQUEST_MISMATCH | 이 requestId는 다른 음성 종류, 설정 또는 샘플에 이미 사용되었습니다. |
| 409 | VOICE_DESIGN_LIMIT_REACHED | 일일 보이스 디자인 허용량을 모두 사용했습니다. |
| 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 | 서버가 다시 시작 중입니다. 잠시 후 재시도하고, 변경 작업의 경우 동일한 요청 식별자를 유지하세요. |
{
"code": "INSUFFICIENT_SCOPE",
"message": "This credential does not permit the requested action.",
"status": 403,
"details": {
"requiredScopes": ["voices:write"]
}
}
이 페이지가 도움이 되었나요?

