> ## 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.
# 음성 생성
> 카탈로그 음성 또는 본인 소유의 맞춤 음성을 사용하여 텍스트에서 음성을 생성합니다. 앱과 동일한 문자 크레딧 및 요금제 한도를 적용합니다. 기록 ID와 임시 오디오 다운로드 URL을 반환합니다. 두 번째 생성을 방지하려면 requestId를 재사용하세요.
카탈로그 음성 또는 본인 소유의 맞춤 음성을 사용하여 텍스트에서 음성을 생성합니다. 앱과 동일한 문자 크레딧 및 요금제 한도를 적용합니다. 기록 ID와 임시 오디오 다운로드 URL을 반환합니다. 두 번째 생성을 방지하려면 requestId를 재사용하세요.
```http theme={null}
POST https://api.voicecheap.ai/v1/actions/tts_generate
```
## 인증 및 권한
이 헤더에 VoiceCheap API 키를 전달하세요. 동일한 API 키를 사용하는 Authorization: Bearer도 지원합니다. OAuth 액세스 토큰은 MCP에서만 허용되며, 이
REST 엔드포인트에서는 사용할 수 없습니다.
필요한 권한: `tts: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}$`.
텍스트 값입니다.
최소 길이: 1. 최대 길이: 128000.
voices\_list의 음성 선택 ID로, 저장된 사용자 지정 음성의 clone: ID도 포함됩니다.
최소 길이: 1. 최대 길이: 255.
텍스트 값입니다.
허용값: "text", "pdf". 기본값: "text".
텍스트 값입니다.
허용값: "default", "cheerful", "calm", "narrator", "dramatic", "whisper", "energetic". 기본값: "default".
텍스트 값입니다.
최대 길이: 300.
숫자 값입니다.
최솟값: 0.5. 최댓값: 2. 기본값: 1.
텍스트 값입니다.
최대 길이: 255.
아래 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}$"
},
"text": {
"type": "string",
"minLength": 1,
"maxLength": 128000
},
"voice": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "A voice selection ID from voices_list, including clone: IDs for saved custom voices."
},
"inputType": {
"default": "text",
"type": "string",
"enum": ["text", "pdf"]
},
"instructionPreset": {
"default": "default",
"type": "string",
"enum": ["default", "cheerful", "calm", "narrator", "dramatic", "whisper", "energetic"]
},
"instructions": {
"type": "string",
"maxLength": 300
},
"speed": {
"default": 1,
"type": "number",
"minimum": 0.5,
"maximum": 2
},
"sourceFileName": {
"type": "string",
"maxLength": 255
}
},
"required": ["text", "voice"],
"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/tts_generate' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"requestId":"284a861a-4da8-4d67-ad48-8123e76c8e91","text":"Hello world.","voice":"933563129e564b19a115bedd57b7406a","inputType":"text","instructionPreset":"narrator","instructions":"Speak clearly and leave a short pause at the end.","speed":1,"sourceFileName":"launch-script.txt"}'
```
```javascript JavaScript theme={null}
const input = {
requestId: '284a861a-4da8-4d67-ad48-8123e76c8e91',
text: 'Hello world.',
voice: '933563129e564b19a115bedd57b7406a',
inputType: 'text',
instructionPreset: 'narrator',
instructions: 'Speak clearly and leave a short pause at the end.',
speed: 1,
sourceFileName: 'launch-script.txt',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/tts_generate', {
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/tts_generate",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91", "text": "Hello world.", "voice": "933563129e564b19a115bedd57b7406a", "inputType": "text", "instructionPreset": "narrator", "instructions": "Speak clearly and leave a short pause at the end.", "speed": 1, "sourceFileName": "launch-script.txt"},
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입니다. 완료된 결과가 별도의 미디어 작업을 가리킬 수 있으므로 해당 작업의 상태 또는 출력 액션을 이어서 사용하세요.
완료된 음성 생성 메타데이터와 임시 MP3 다운로드 URL입니다. 핸들러는 오디오 바이트를 반환하지 않습니다.
```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": {
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
"historyId": "722c80c6412edd4c3dcd625061e1c1feafbb0d54274d95fd8b5ca047f8cdd23d",
"status": "completed",
"characterCount": 12,
"previewEndIndex": null,
"downloadUrl": "https://files.example.com/launch-script-speech.mp3"
},
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91"
}
```
```json HTTP 202 replay_running theme={null}
{
"data": {
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
"operation": "tts_generate",
"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": "tts_generate",
"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.requestId` | 생성 액션에 전달한 UUID v4입니다. |
| `data.historyId` | 본인 소유 음성 기록 ID로, 64자의 소문자 16진수 문자입니다. 앱 미리보기의 경우 선택적으로 free- 접두사가 붙습니다. |
| `data.status` | 음성 결과가 준비되면 completed입니다. |
| `data.characterCount` | 앞뒤 공백을 제거한 전체 입력 텍스트의 문자 수입니다. |
| `data.previewEndIndex` | 부분 미리보기 오디오의 글자 경계이며 전체 오디오의 경우 null입니다. 유료 연동 생성은 전체 오디오를 반환합니다. |
| `data.downloadUrl` | 임시 MP3 다운로드 URL입니다. tts\_download로 새 URL을 요청하세요. |
## 이 요청 복구 및 폴링
연결이 끊어진 후에도 동일한 식별자를 사용하세요. 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":"tts_generate"}'
```
```json HTTP 200 theme={null}
{
"data": {
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
"operation": "tts_generate",
"status": "completed",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"resultStored": true,
"result": {
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
"historyId": "722c80c6412edd4c3dcd625061e1c1feafbb0d54274d95fd8b5ca047f8cdd23d",
"status": "completed",
"characterCount": 12,
"previewEndIndex": null,
"downloadUrl": "https://files.example.com/launch-script-speech.mp3"
}
}
}
```
## 작업 참고 사항
* 이 변경 작업에 UUID v4 requestId를 사용하고 재시도 시 동일한 인수와 함께 재사용하세요. 장시간 실행되는 액션은 먼저 running 요청을 반환합니다. 이 예시는 action\_request\_get에서 얻을 수 있는 완료된 핸들러 결과입니다.
* voices\_list에서 voice를 선택하세요. dubbing\_voices\_list의 더빙 음성 ID는 별도의 라이브러리입니다.
* 텍스트의 앞뒤 공백이 제거됩니다. 스키마는 최대 128,000자를 허용합니다. 현재 Beginner와 Starter 요금제는 생성당 64,000자를 허용하며 Creator 이상 요금제는 128,000자를 허용합니다. 생성 전에 현재 요금제와 사용 가능한 TTS 글자 크레딧을 다시 확인합니다.
* inputType의 기본값은 text이며 text 또는 pdf일 수 있습니다. pdf인 경우에도 추출한 텍스트를 text에 제공해야 합니다. 이 액션은 PDF 업로드나 URL을 받지 않습니다.
* instructionPreset의 기본값은 default이며 default, cheerful, calm, narrator, dramatic, whisper 및 energetic을 지원합니다. instructions는 선택 사항이며 앞뒤 공백 제거 후 300자로 제한됩니다. speed의 기본값은 1이며 범위는 0.5에서 2까지입니다.
* sourceFileName은 선택적 메타데이터로, 앞뒤 공백 제거 후 255자로 제한되며 다운로드 파일명을 결정합니다.
* 성공한 요청을 반복하면 다시 생성하거나 요금을 청구하지 않고 저장된 오디오를 재전달합니다. URL은 임시 URL입니다. 새 다운로드를 받으려면 tts\_download를 사용하세요.
* 음성 합성 기록과 사용자 지정 음성은 인증된 계정에 속합니다. 팀 결제를 사용해도 다른 멤버의 음성 합성 결과나 음성에 접근할 수 없습니다.
## 사용량
성공한 호출마다 월간 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 | `INVALID_VOICE` | 음성 선택이 유효하지 않거나, 이 계정의 소유가 아니거나, ready 상태가 아닙니다. |
| 400 | `TEXT_REQUIRED` | 발화 제어 태그를 제거한 후 스크립트가 비어 있습니다. |
| 400 | `TEXT_TOO_LONG` | 스크립트가 현재 요금제의 생성당 글자 수 한도를 초과합니다. |
| 400 | `VALIDATION_ERROR` | 입력이 액션 스키마와 일치하지 않습니다. 필드 오류는 details를 확인하세요. |
| 400 | `VOICE_UNAVAILABLE` | 선택한 카탈로그 음성을 더 이상 사용할 수 없습니다. voices\_list가 반환한 ID를 선택하세요. |
| 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 | `PAID_PLAN_REQUIRED` | 현재 계정에는 더 이상 통합 음성 생성용 유료 요금제가 없습니다. |
| 403 | `SUBSCRIPTION_REQUIRED` | 활성 유료 구독을 사용하세요. |
| 403 | `TEAM_OWNER_NOT_FOUND` | 실제로 적용되는 팀 소유자 계정을 찾을 수 없습니다. |
| 409 | `CONCURRENT_ACTION_LIMIT_REACHED` | 이 계정에서는 이미 10개의 연동 액션이 실행 중입니다. 새 액션을 시작하기 전에 기존 요청을 폴링하세요. |
| 409 | `IDEMPOTENCY_CONFLICT` | 동일한 작업과 인수에 대해서만 식별자를 재사용하세요. |
| 409 | `TEXT_TO_SPEECH_GENERATION_IN_PROGRESS` | 동일한 음성 요청이 아직 processing 상태입니다. |
| 409 | `TEXT_TO_SPEECH_REQUEST_CONFLICT` | 이 requestId는 이미 다른 음성 입력과 함께 사용되었습니다. |
| 429 | `INTEGRATION_MONTHLY_LIMIT_REACHED` | 월간 한도가 초기화될 때까지 기다리거나 요금제를 변경하세요. |
| 429 | `INTEGRATION_RATE_LIMIT_REACHED` | Retry-After가 있으면 지정된 시간만큼 기다리고 백오프를 적용하세요. |
| 429 | `TEXT_TO_SPEECH_CHARACTER_LIMIT_REACHED` | 스크립트가 사용 가능한 기본 제공 및 구매한 TTS 문자의 합계를 초과합니다. |
| 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": ["tts:write"]
}
}
```
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.