CLOVA Studio overview

Prev Next

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.

  1. In the NAVER Cloud Platform console, click Services > AI Services > CLOVA Studio menus, in that order.
  2. Click on your username in the top right corner of the page, and then click then API key menu.
  3. 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
  4. 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.
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.

Note

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.

  1. In the NAVER Cloud Platform console, click Services > AI Services > CLOVA Studio menus, in that order.
  2. Click on your username in the top right corner of the page, and then click then API key menu.
  3. When the API key page appears, click the tab menu where the API key to delete is located.
  4. Click i_clovastudio-more of the API key to delete, and click the Delete menu.
  5. When the Delete API key pop-up window appears, click the [Delete] button.
  6. 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.

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:

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

You can continue to use CLOVA Studio API with the existing request API URL (https://clovastudio.apigw.ntruss.com/), but we recommend changing it as it will be discontinued. 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 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 compatible API)
    {
"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 Generate interactive sentences utilizing the HyperCLOVA X model.
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.
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.
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.
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.
Skillset Generate answers with skillset API calls.
Router Perform domain and filter determination for user input.

CLOVA Studio related resources

NAVER Cloud Platform provides a variety of related resources to help users better understand CLOVA Studio APIs.