- 인쇄
- PDF
CLOVA Studio 개요
- 인쇄
- PDF
Classic/VPC 환경에서 이용 가능합니다.
CLOVA Studio는 초대규모(Hyperscale) AI 기술인 HyperCLOVA X 언어 모델을 활용하여 사용자가 입력한 내용에 따라 AI 기술을 통해 생성된 문구를 출력하는 네이버 클라우드 플랫폼의 서비스입니다. CLOVA Studio 서비스에서는 문장 생성, 튜닝, 익스플로러, 스킬 트레이너 기능에 대한 API를 RESTful 형태로 제공합니다.
API 키
CLOVA Studio API는 권한을 가진 사용자만 호출할 수 있도록 사용자 식별 도구인 API 키를 계정별로 발급하고 있습니다. API 키는 API 호출 시 인증 정보로 전달하는 요청 헤더의 파라미터로 사용합니다. 따라서 CLOVA Studio API를 사용하려면 우선 API 키를 발급받아야 합니다.
API 키 발급
API 키는 네이버 클라우드 플랫폼 콘솔의 CLOVA Studio에서 발급할 수 있습니다. 발급 방법은 다음과 같습니다.
- 네이버 클라우드 플랫폼 콘솔에서 Services > AI Services > CLOVA Studio 메뉴를 차례대로 클릭해 주십시오.
- 화면 우측 상단의 사용자명을 클릭한 다음 API 키 메뉴를 클릭해 주십시오.
- API 키 화면이 나타나면 발급할 API 키 탭 메뉴를 클릭한 다음 발급 버튼을 클릭해 주십시오.
- 테스트 API 키: 테스트 탭 선택 > 테스트 API 키 발급
- 서비스 앱을 제외한 CLOVA Studio API 호출 시 이용 가능
- 서비스 API 키: 서비스 탭 선택 > 서비스 API 키 발급
- 서비스 앱을 포함한 모든 CLOVA Studio API 호출 시 이용 가능
- 테스트 API 키: 테스트 탭 선택 > 테스트 API 키 발급
- API 키 발급 팝업 창이 나타나면 발급 버튼을 클릭해 주십시오.
- API 키 복사 팝업 창에서 발급된 API 키를 복사합니다.
발급된 API 키는 API 키 복사 팝업 창을 닫은 후에는 확인이 불가능합니다. 따라서 반드시 발급 시점에 별도의 안전한 공간에 보관하여 주십시오.
테스트 API 키, 서비스 API 키는 네이버 클라우드 플랫폼의 메인 계정 기준으로 각각 최대 10개까지 생성할 수 있습니다.
API 보안 설정
API 키가 제3자에게 유출되는 경우, CLOVA Studio 리소스를 임의로 이용하는 등의 보안 문제가 발생할 수 있으므로 적절한 사전 대비와 대응이 필요합니다.
API 키 삭제 및 재발급
API 키를 사용하지 않거나 제3자의 도용이 의심된다면 발급한 API 키를 삭제한 후 다시 발급해야 합니다. 삭제 및 재발급 방법은 다음과 같습니다.
- 네이버 클라우드 플랫폼 콘솔에서 Services > AI Services > CLOVA Studio 메뉴를 차례대로 클릭해 주십시오.
- 화면 우측 상단의 사용자명을 클릭한 다음 API 키 메뉴를 클릭해 주십시오.
- API 키 화면이 나타나면 삭제할 API 키가 있는 탭 메뉴를 클릭해 주십시오.
- 삭제할 API 키의
을 클릭한 다음 삭제 메뉴를 클릭해 주십시오.
- API 키 삭제 팝업 창이 나타나면 [삭제] 버튼을 클릭해 주십시오.
- API 키 발급을 참조하여 새로운 API 키를 발급해 주십시오.
삭제한 API 키는 유효하지 않은 키로 인식되기 때문에 더 이상 API 호출에 사용할 수 없습니다.
공통 설정
CLOVA Studio API에서 공통으로 사용하는 형식 및 설정을 설명합니다.
테스트 앱 생성
CLOVA Studio API를 사용하려면 테스트 앱 또는 서비스 앱을 생성해야 합니다. 앱은 네이버 클라우드 플랫폼 콘솔에서 생성할 수 있습니다. 자세한 내용은 CLOVA Studio 사용 가이드를 참조해 주십시오.
요청
공통 요청 형식을 설명합니다.
API URL
요청 API URL은 다음과 같습니다.
https://clovastudio.stream.gov-ntruss.com/
https://clovastudio.apigw.gov-ntruss.com/
로도 CLOVA Studio API를 이용할 수 있으나, 제공 중단 예정되어 있어 위의 API URL로 변경할 것을 권고드립니다. 또한 기존 요청 API URL을 이용할 경우 신규 API 키를 통한 인증이 불가하며 생성되는 토큰을 하나씩 출력하는 스트리밍 응답을 사용할 수 없습니다.
요청 헤더
요청 헤더에 대한 설명은 다음과 같습니다.
필드 | 필수 여부 | 설명 (예시) |
---|---|---|
Authorization | Required | 인증을 위한 API 키 (예: Bearer nv-********** ) |
Content-Type | Required | application/json |
응답
공통 응답 형식을 설명합니다.
응답 바디
응답 바디에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
status | Object | - | 응답 상태 |
status.code | String | - | 응답 상태 코드 |
status.message | String | - | 응답 메시지 |
result | Any | - | 응답 결과 |
응답 상태 코드별 원인 및 해결 방법은 CLOVA Studio 문제 해결을 참조해 주십시오.
응답 예시
응답 예시는 다음과 같습니다.
- 성공
{ "status": { "code": "20000", "message": "OK" }, "result": {} }
- 실패(클라이언트 오류)
{ "status": { "code": "40102", "message": "Invalid access token" } }
- 실패(서버 오류)
{ "status": { "code": "50000", "message": "Internal Server Error" } }
CLOVA Studio API
CLOVA Studio에서 제공하는 API는 다음과 같습니다.
API | 설명 |
---|---|
Chat Completions | HyperCLOVA X 모델을 활용한 대화형 문장 생성 |
학습 조회 | 학습 현황 조회 |
학습 목록 조회 | 생성한 학습 목록 조회 |
학습 생성 | 사용자의 데이터셋을 사용한 학습 생성 |
학습 삭제 | 생성한 학습 삭제 |
토큰 계산기(챗) | HCX 모델에서 입력한 문장의 토큰 수 계산 |
토큰 계산기(임베딩v2) | 임베딩 v2에서 입력한 문장의 토큰 수 계산 |
슬라이딩 윈도우 | Chat Completions 이용 시 최대 토큰 수를 초과하는 문장 처리 |
문단 나누기 | 문장 간 유사도를 파악하여 주제 단위로 글의 단락 구분 |
요약 | 다양한 옵션을 적용하여 긴 문장 요약 |
임베딩 v2 | 장문 텍스트를 숫자로 표현하는 벡터화 작업 수행 |
스킬셋 답변 생성 | 스킬셋 API 호출로 답변 생성 |
CLOVA Studio 연관 리소스
CLOVA Studio API에 대한 사용자의 이해를 돕기 위해 다양한 연관 리소스를 제공하고 있습니다.
- CLOVA Studio API 사용 방법
- API 개요: 네이버 클라우드 플랫폼에서 발급받은 Access Key, Secret Key 발급 및 확인, 요청 헤더에 필요한 서명 생성 방법
- Sub Account 사용 가이드: 네이버 클라우드 플랫폼에서 발급받은 서브 계정의 Access Key 발급 및 확인 방법
- CLOVA Studio 서비스 사용 방법
- CLOVA Studio 사용 가이드: 네이버 클라우드 플랫폼 콘솔에서 CLOVA Studio 사용하는 방법
- Ncloud 사용 환경 가이드: VPC, Classic 환경 및 지원 여부에 관한 사용 가이드
- 요금 소개, 특징, 상세 기능: CLOVA Studio의 요금 체계, CLOVA Studio의 특징, 상세 기능 및 활용 예시 요약
- 서비스 최신 소식: CLOVA Studio 관련 최신 소식
- 문의하기: 사용 가이드를 통해서도 궁금증이 해결되지 않는 경우 직접 문의