CLOVA Studio overview

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, router, and skill trainer features in RESTful form.

API key

The CLOVA Studio API issues an API key, an 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.

Access the NAVER Cloud Platform console.
In the Region menu, click on the environment you are using.
In the Platform menu, click the environment you are using.
Click the Services > AI Services > CLOVA Studio menus, in that order.
Click the API key menu at the left side of the page.
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: Click [Test] tab menu > Click [Issue test API key]
  - Available when calling CLOVA Studio APIs except for service apps
  - Up to 10 keys can be created per NAVER Cloud Platform account.
- Service API key: Click [Service] tab menu > Click [Issue service API key]
  - Available when calling CLOVA Studio APIs of registered service apps
  - Up to 10 keys can be created per NAVER Cloud Platform account.
When the Copy API key pop-up window appears, click the [Issue] button.
Click the [Copy] button, and then click the [Complete] button.

Caution

The 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.

Check old version API key (deprecated)

You can view API keys issued before January 2025 for test apps or registered service apps.

Test app

The following describes how to view a test app's API key.

In the NAVER Cloud Platform console, click Services > AI Services > CLOVA Studio menus, in that order.
Click the API key menu at the left side of the page.
When the API key page appears, click the [Deprecated] tab menu.
Click , and check the API key by clicking the Copy menu.
Click the [View API Gateway key] button at the upper right corner.
When the API Gateway key pop-up window appears, check the API Gateway key.

Caution

As soon as you reissue the API Gateway key, you won't be able to use the test app or service app that you were using with the previous key. Therefore, please check the impact and take precautionary measures before proceeding only if absolutely necessary.

Service app

The following describes how to view a service app's API key.

In the NAVER Cloud Platform console, click Services > AI Services > CLOVA Studio menus, in that order.
Click the Request service app menu at the left side of the page.
Click the View code button in the service app.
Click the [Existing] tab menu to check the old version API key of the service app, and then check the API Gateway key.
- API key: X-NCP-CLOVASTUDIO-API-KEY
- API Gateway key: X-NCP-APIGW-API-KEY

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 the API key menu at the left side of the page.
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.

Caution

Deleted API keys are recognized as invalid keys and can no longer be used for API calls. Therefore, please check the impact and take precautionary measures before proceeding only if absolutely necessary.

Common settings

The following describes commonly used request and response formats in CLOVA Studio APIs.

Note

If you have a CLOVA Studio API key, you can use the CLOVA Studio API right away. However, if you want to use a service app with a service API key, you need to go through a separate subscription process. See the CLOVA Studio User Guide for how to request it.

Request

The following describes the common request format.

API URL

The request API URL is as follows:

https://clovastudio.stream.ntruss.com/

Note

The old version of the request API URL (https://clovastudio.apigw.ntruss.com/) can still be used for CLOVA Studio API calls, but we recommend using https://clovastudio.stream.ntruss.com/ as it is scheduled for deprecation. When calling the old version of the request API URL, you won't be able to authenticate with the new API key, and you can't use the streaming response that outputs the generated tokens one by one.

Request headers

The following describes the request headers.

Field	Required	Description (example)
Authorization	Required	API key for authentication Example: `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

Note

For causes and solutions for each response status code, see Troubleshooting CLOVA Studio.

Response example

The response example is as follows:

Succeeded

{
  "status": {
    "code": "20000",
    "message": "OK"
  },
  "result": {}
}

Failure

{
"status": {
    "code": "50000",
    "message": "Internal Server Error"
    }
}

Failure (OpenAI compatibility)

{
"error": {
    "message": "Internal Server Error",
    "type": null,
    "param": null, // Not supported
    "code": "50000"
    }
}

CLOVA Studio API

The APIs provided by CLOVA Studio are as follows:

API	Description
Chat Completions v3 (text and image)	Interpret images or generate interactive sentences using vision/language model.
Chat Completions v3 (Fuction calling)	Function calling, which allows you to dynamically retrieve information or perform tasks by calling external functions or APIs.
Chat Completions	Generate interactive sentences utilizing the HyperCLOVA X model.
Completions	Generate sentences using the normal mode (LK model) of Playground.
OpenAI compatibility	Provide OpenAI SDK and API compatibility for key APIs.
Get training	Get training status.
Get training list	Get created training list.
Create training	Create training using user dataset.
Delete training	Delete created training.
Reranker	Generate RAG answers using search documents that are highly relevant to user queries.
RAG Reasoning	Generate evidence-based answers with the RAG Reasoning model.
Token calculator (chat)	Calculate number of tokens in sentences entered in the HCX model (Chat Completions API).
Token calculator (chat v3)	Calculate number of tokens in sentences and images entered in the HCX model (Chat Completions v3 API).
Token calculator (Embedding v2)	Calculate the number of tokens in a sentence entered in Embeddings v2.
Tokenizer	Calculate number of tokens in sentences entered in models other than HCX (Completions API).
Sliding Window API	Process sentences that exceed the maximum number of tokens when using Chat completions.
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.
Break paragraph	Identify paragraphs in a post by topic by identifying similarities between sentences.
Router	Perform domain and filter determination for user input.
Skillset	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 Guides: 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