- Print
- PDF
CLOVA Studio overview
- Print
- PDF
Available in Classic and VPC
CLOVA Studio is a NAVER Cloud Platform service that utilizes the HyperCLOVA language model, a hyperscale AI technology, to output phrases generated by AI technology based on user input. The CLOVA Studio service provides APIs for sentence generation, tuning, explorer, and skill trainer features in RESTful form.
API key
The CLOVA Studio API issues an API key, a user identification tool, to each account so that only authorized users can call it. The API key is used as a parameter in the request header that is passed as authentication information when calling the API. Therefore, to use the CLOVA Studio API, you must first obtain an API key.
Issue API key
API keys can be issued in CLOVA Studio in the NAVER Cloud Platform console. The following describes how to issue them.
- In the NAVER Cloud Platform console, click Services > AI Services > CLOVA Studio menus, in that order.
- Click on your username in the top right corner of the page, and then click then API key menu.
- When the API key page appears, click the tab menu of the API key you want to issue, and then click the Issue button.
- Test API key: Select Test tab > Issue test API key
- Available when calling CLOVA Studio APIs except for service apps
- Service API key: Select Service tab > Issue service API key
- Available when calling CLOVA Studio APIs including service apps
- Test API key: Select Test tab > Issue test API key
- When the Issue API key pop-up window appears, click the Issue button.
- In the Copy API key pop-up window, copy the issued API key.
CautionThe issued API key cannot be verified after the Copy API key pop-up window is closed. Therefore, be sure to store it in a separate safe space at the time of issuance.
You can create up to 10 test API keys and service API keys based on the main account of the NAVER Cloud Platform.
Set API security
If the API key is leaked to a third party, security issues may arise, such as unauthorized use of CLOVA Studio resources, so proper preparation and response are required.
Delete and reissue API key
If you do not use the API key or suspect that it has been stolen by a third party, you must delete the issued API key and reissue it. The following describes how to delete and reissue the API key.
- In the NAVER Cloud Platform console, click Services > AI Services > CLOVA Studio menus, in that order.
- Click on your username in the top right corner of the page, and then click then API key menu.
- When the API key page appears, click the tab menu where the API key to delete is located.
- Click
of the API key to delete, and click the Delete menu.
- When the Delete API key pop-up window appears, click the [Delete] button.
- See Issue API key and issue a new API key.
Deleted API keys are recognized as invalid keys and can no longer be used for API calls.
Common attributes
The following describes commonly used request and response formats in CLOVA Studio APIs.
Create test app
If you want to use CLOVA Studio APIs, then you must create a test or service app first. These apps can be created in the NAVER Cloud Platform console. For more information, see CLOVA Studio User Guide.
Request
The following describes the common request format.
API URL
The request API URL is as follows.
You can also use the CLOVA Studio API with https://clovastudio.apigw.ntruss.com/
, but we recommend that you change to the API URL above as it is scheduled to be discontinued. In addition, if you use the existing request API URL, you won't be able to authenticate with the new API key and use the streaming response that outputs the generated token one by one.
Request headers
The following describes the request headers.
Field | Required | Description (example) |
---|---|---|
Authorization | Required | API key for authentication (e.g., Bearer nv-********** ) |
Content-Type | Required | application/json |
Response
The following describes the common response format.
Response body
The response body includes the following data:
Field | Type | Required | Description |
---|---|---|---|
status | Object | - | Response status |
status.code | String | - | Response status codes |
status.message | String | - | Response Message |
result | Any | - | Response result |
For causes and solutions for each response status code, see Troubleshooting CLOVA Studio.
Response example
The response example is as follows:
- Succeeded
- Failure (client error)
- Failure (server error)
CLOVA Studio API
The APIs provided by CLOVA Studio are as follows.
API | Description |
---|---|
Chat Completions | Generate interactive sentences utilizing the HyperCLOVA X model |
Completions | Generate sentences using the normal mode (LK model) of Playground |
Get training | Get training status |
Get training list | Get created training list |
Create training | Create training using user dataset |
Delete training | Delete created training |
Token calculator (chat) | Calculate the number of tokens in a sentence entered in a HCX model |
Token calculator (Embedding v2) | Calculate the number of tokens in a sentence entered in Embeddings v2 |
Tokenizer | Calculate the number of tokens in a sentence entered in a non-HCX model |
Sliding Window API | Process sentences that exceed the maximum number of tokens when using Chat completions |
Break paragraph | Identify paragraphs in a post by topic by identifying similarities between sentences |
Summary | Summarize long sentences by applying different options |
Embedding | Perform vectorization tasks to represent text as numbers |
Embedding v2 | Perform vectorization tasks to represent long text as numbers |
Generate skillset answer | Generate answers with skillset API calls |
CLOVA Studio related resources
NAVER Cloud Platform provides a variety of related resources to help users better understand CLOVA Studio APIs.
- CLOVA Studio API guides
- API overview: how to issue and check access key and secret key issued by NAVER Cloud Platform, how to generate the signature required for request headers
- Sub Account User Guide: how to issue and check access keys for sub accounts issued by NAVER Cloud Platform
- How to use the CLOVA Studio service
- CLOVA Studio User Guide: how to use CLOVA Studio in the NAVER Cloud Platform console
- Ncloud use environment guide: guide on VPC and Classic environments and supported features
- Introduction to pricing, characteristics, and detailed features: summary of CLOVA Studio pricing system, characteristics, detailed features, and utilization examples of CLOVA Studio
- Latest service news: the latest news on CLOVA Studio
- Contact us: Send direct inquiries in case of any unresolved questions that aren't answered by the user guides.
- CLOVA Studio forum: CLOVA Studio related announcements, how-to's, user experience sharing, and support inquiries