Prosody

개요

API를 사용하려면 API 키가 필요합니다.

API 키

API를 사용하려면 먼저 API 키를 발급받아야 합니다.

API 키 발급

대시보드에서 API 키를 생성하고 관리할 수 있습니다.

API 키 관리

API 키 사용

음성 API는 X-API-Key를, AICC Runtime API는 Authorization: Bearer를 사용합니다.

DIVE · FRTTS · STT · 저장 목소리 · 단어장

X-API-Key: your_api_key_here

AICC Runtime API

Authorization: Bearer your_api_key_here

⚠️ 보안 주의: API 키는 절대 클라이언트 코드에 노출하지 마세요. 서버 사이드에서만 사용하세요.

HTTP 상태 코드

API 응답의 성공/실패 여부는 HTTP 상태 코드로 판단합니다. 음성 API는 중첩 오류 형식을, AICC는 같은 공통 code를 포함한 평면 오류 형식을 사용합니다.

오류 응답 형식

오류 발생 시 다음과 같은 JSON 형식으로 응답합니다.

음성 API

{
  "error": {
    "code": "E4201",
    "message": "Invalid request",
    "details": "Missing required field: text"
  }
}

AICC API

{
  "error": "message or a user message in history is required",
  "code": "E4201"
}

AICC는 호환성을 위해 평면 형식을 사용하지만, code 값은 음성 API와 같은 공통 오류 코드표를 따릅니다.

상태 코드 목록

코드의미설명
200OK요청이 성공적으로 처리됨
400Bad Request필수 파라미터 누락 또는 잘못된 형식
401UnauthorizedAPI 키가 유효하지 않거나 누락됨
402Payment Required요청을 예약할 크레딧이 부족함
403Forbidden해당 리소스에 대한 접근 권한 없음
404Not Found요청한 리소스를 찾을 수 없음
405Method Not Allowed허용되지 않은 HTTP 메서드
409Conflict리소스가 아직 요청을 처리할 준비가 되지 않음
413Payload Too Large요청 body가 엔드포인트 제한을 초과함
429Too Many Requests요청 한도 초과 (Rate Limit)
500Internal Server Error서버 내부 오류
503Service Unavailable서비스를 일시적으로 사용할 수 없음