사용가이드

공통 설정

인증키 발급

인증 토근 발급받기 위한 계정 생성 이름, 이메일, 패스워드 입력 후 계정을 생성 해야만 정상적으로 사용이 가능합니다.

토큰 발급을 위한 로그인

이메일 / 패스워드 입력 토큰 값 발급 후 인증 통해 정상적으로 API 를 이용 하실 수 있습니다.

발급 토큰 유효

토큰은 발급 1시간 후 자동 파기 됩니다. 재 발급 받으셔야 정상 이용 가능하십니다.

API URL

Method Request URI
POST /api/v1/tts

요청 헤더

헤더명 설명
Authorization 로그인 또는 회원 가입 후 발급 받은 토큰키 입력 Bearer {토큰값}
Content-Type application/json

요청 파라미터

name type desc default requirement
speaker string 음성 합성에 사용할 목소리 종류 Kor Y
text string - 음성 합성할 문장
UTF-8 인코딩된 텍스트만 지원
최대 2,000 자의 텍스트까지 음성 합성을 지원
기호나 괄호 안의 텍스트는 읽지 않음
N Y
volume integer - 음성 볼륨
-5에서 5 사이의 정수 값이며, -5 이면 0.5 배 낮은 볼륨이고 5 이면 1.5 배 더 큰 볼륨
0 이면 정상 볼륨의 목소리로 음성을 합성함
0 N
speed integer - 음성 속도
-5에서 5 사이의 정수 값이며, -5 이면 2 배 빠른 속도이고 5 이면 0.5 배 더 느린 속도
0 이면 정상 속도의 목소리로 음성을 합성함
0 N
pitch integer - 음성 피치
-5에서 5 사이의 정수 값이며, -5 이면 1.2 배 높은 피치이고 5 이면 0.8 배 더 낮은 피치
0 이면 정상 피치의 목소리로 음성을 합성함
0 N
emotion integer - 음성 감정
0에서 2 사이의 정수 값이며 0 은 기본, 1 은 어두운, 2 는 밝은 음성임 (nara만 사용 가능)
0 N
format string - 음성 포멧
mp3 또는 wav 입력 바람
mp3 N
sampling-rate integer sampling rate. sampling rate 는 wav 포멧만 지원됨
ex. 8000, 16000, 24000, 48000
24000 N

오류 코드

공통 오류
HttpStatusCode ErrorCode ErrorMessage Description
400 100 Bad Request Exception protocol(https), endocing(UTF-8) 등 request 오류
401 200 Authentication Failed 인증실패
401 210 Permission Denied 권한없음
404 300 Not Found Exception 권한없음
429 400 Quota Exceeded Quota 초과
429 410 Throttle Limited Rate 초과
429 420 Rate Limited Rate 초과
413 430 Request Entity Too Large content-length 초과 (10MB)
503 500 Endpoint Error 엔드포인트 연결오류
504 510 Endpoint Timeout 엔드포인트 연결시간 초과
500 900 Unexpected Error 예외처리가 안된 오류
API 오류
HttpStatusCode ErrorCode ErrorMessage Description
400 VS01 speaker parameter is needed. speaker 파라미터가 누락됨
400 VS02 Unsupported speaker. speaker 파라미터에 지원하지 않는 값이 입력된 경우 발생
400 VS03 speed parameter is needed. speed 파라미터가 누락됨
400 VS04 Unsupported speed. speed 파라미터에 지원하지 않는 값이 입력된 경우 발생
400 VS05 text parameter is needed. text 파라미터가 누락됨
400 VS06 text parameter exceeds max length. text 파라미터에 입력할 수 있는 최대 글자 수 초과
500 VS99 Internal server error 서버 내부 오류 발생
고객지원을 통해 문의하면 신속히 조치 가능