APIs key

Available in Classic and VPC

On the APIs key issuance interface, you can view the issued keys and check whether they are enabled for use at a glance.

APIs key

CLOVA Studio APIs issues APIs keys on a per account basis as an identification tool so that only authorized users can call the APIs. Use the APIs key as a parameter in the request header to pass authentication information when making APIs calls. To use the CLOVA Studio APIs, issue an APIs key first.

Issue an APIs key

You can issue an APIs key in CLOVA Studio from the NAVER Cloud Platform console. To issue an APIs key:

1. In the NAVER Cloud Platform console, navigate to > Services > AI Services > CLOVA Studio.
2. On the left side of the interface, click APIs key menu.
3. When the APIs key interface appears, select the tab for the APIs key you want to issue, and then click Issue.
   • Test APIs key: Click the [Test] tab > and then click [Issue test APIs key].
     • You can use the test APIs key to call the CLOVA Studio APIs, except for service apps.
     • You can create up to 10 test APIs keys per NAVER Cloud Platform main account.
   • Service APIs key: Click the [Service] tab > and then click [Issue service APIs key].
     • You can use the service APIs key to call the CLOVA Studio APIs for registered service apps.
     • You can create up to 10 test APIs keys per NAVER Cloud Platform main account.
4. When the APIs key copy popup appears, click [Issue].
5. Click [Copy] and then click [Done].

Check legacy APIs keys (Deprecated)

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

Test app

To check the APIs key for a test app:

1. In the NAVER Cloud Platform console, navigate to > Services > AI Services > CLOVA Studio.
2. On the left side of the interface, click APIs key menu.
3. When the APIs key interface appears, click the [Deprecated] tab.
4. {height="" width=""}Click the Copy to view the APIs key.
5. Click [View API Gateway key] in the upper-right corner.
   6.When the API Gateway key popup appears, check the API Gateway key.

Service app

To check the APIs key for a service app:

1. In the NAVER Cloud Platform console, navigate to > Services > AI Services > CLOVA Studio.
2. On the left side of the interface, click Service app application menu.
3. Click View code for the service app.
4. Click [Legacy] tab to check the service app’s legacy APIs key, and then check the API Gateway key.

• APIs key: X-NCP-CLOVASTUDIO-API-KEY
• API Gateway key: X-NCP-APIGW-API-KEY

APIs security settings

If an APIs key is exposed to a third party, CLOVA Studio resources may be used without authorization, which can cause security issues. Make sure to take appropriate preventive measures and prepare response actions in advance.

Delete and reissue an APIs key

If you no longer use an APIs key or suspect it has been compromised, delete the issued APIs key and issue a new one. To delete and reissue an APIs key:

1. In the NAVER Cloud Platform console, navigate to > Services > AI Services > CLOVA Studio.
2. On the left side of the interface, click APIs key menu.
3. When the APIs key interface appears, click the tab that contains the APIs key you want to delete.
4. Click {height="" width=""} for the APIs key you want to delete, and then click Delete menu.
5. When the APIs key deletion popup appears, click [Delete].
6. See Issue an APIs key to issue a new APIs key.