CLOVA Studioの概要

Prev Next

Classic/VPC環境で利用できます。

CLOVA Studioは、超大規模(Hyperscale) AI技術である HyperCLOVA言語モデルを活用して、ユーザーが入力した内容に基づき AI技術によって生成された文言を出力する NAVERクラウドプラットフォームのサービスです。CLOVA Studioサービスでは、文章の生成、チューニング、エクスプローラ、ルーター、スキルトレーナー機能関連の APIを RESTful形式で提供します。

APIキー

CLOVA Studio APIは、権限を持つユーザーのみ呼び出すことができるように識別ツールである APIキーをアカウントごとに発行しています。APIキーは、API呼び出し時の認証情報として渡すリクエストヘッダのパラメータとして使用します。そのため、CLOVA Studio APIを使用するには、先に APIキーを発行する必要があります。

APIキーの発行

APIキーは NAVERクラウドプラットフォームコンソールの CLOVA Studioで発行できます。発行方法は次の通りです。

  1. NAVERクラウドプラットフォームコンソールにアクセスします。
  2. Regionメニューで利用中の環境をクリックします。
  3. Platformメニューから利用中の環境をクリックします。
  4. Services > AI Services > CLOVA Studioメニューを順にクリックします。
  5. 画面左側の APIキーメニューをクリックします。
  6. APIキー画面が表示されたら発行する APIキータブメニューをクリックし、発行ボタンをクリックします。
    • テスト APIキー: [テスト] タブメニューをクリック > [テスト APIキーを発行] ボタンをクリック
      • サービスアプリ以外の CLOVA Studio APIの呼び出し時に利用可能
      • NAVERクラウドプラットフォームメインアカウント基準で最大10個まで作成可能
    • サービス APIキー: [サービス] タブメニューをクリック > [サービス APIキーを発行] ボタンをクリック
      • 登録完了したサービスアプリの CLOVA Studio APIの呼び出し時に利用可能
      • NAVERクラウドプラットフォームメインアカウント基準で最大10個まで作成可能
  7. APIキーコピーのポップアップが表示されたら、 [発行] ボタンをクリックします。
  8. [コピー] ボタンをクリックした後、 [完了] ボタンをクリックします。
注意

APIキーコピーのポップアップを閉じると、発行した APIキーの確認はできなくなります。発行時に必ず別の安全な場所に保管してください。

旧バージョン APIキーの確認 (Deprecated)

2025年1月以前に発行したテストアプリまたは登録したサービスアプリに対して発行した APIキーを確認することができます。

テストアプリ

テストアプリの APIキーを確認する方法は次の通りです。

  1. NAVERクラウドプラットフォームコンソールで Services > AI Services > CLOVA Studioメニューを順にクリックします。
  2. 画面左側の APIキーメニューをクリックします。
  3. APIキー画面が表示されたら、 [Deprecated] タブメニューをクリックします。
  4. i_clovastudio-moreをクリックし、コピーメニューをクリックして APIキーを確認します。
  5. 右上の [API Gatewayキーを表示] ボタンをクリックします。
  6. API Gatewayキーのポップアップが表示されたら、API Gatewayキーを確認します。
注意

API Gatewayキーを再発行すると、以前のキーで利用していたテストアプリ、サービスアプリは直ちに利用できなくなります。影響度を確認し、事前対策を行った上で、必要な場合にのみ行ってください。

サービスアプリ

サービスアプリの APIキーを確認する方法は次の通りです。

  1. NAVERクラウドプラットフォームコンソールで Services > AI Services > CLOVA Studioメニューを順にクリックします。
  2. 画面左からサービスアプリの申し込みメニューをクリックします。
  3. サービスアプリのコードを表示ボタンをクリックします。
  4. [既存] タブメニューをクリックしてサービスアプリの旧バージョン APIキーを確認し、API Gatewayキーを確認します。
    • APIキー: X-NCP-CLOVASTUDIO-API-KEY
    • API Gatewayキー: X-NCP-APIGW-API-KEY

APIのセキュリティ設定

APIキーが第三者に流出する場合、CLOVA Studioリソースを任意に利用するなどセキュリティ上の深刻な問題が発生する可能性があるので、適切な事前準備と対応が必要です。

APIキーの削除と再発行

APIキーを使用していない場合や、第三者の盗用が疑われる場合は、発行した APIキーを削除し、再度発行する必要があります。削除および再発行方法は次の通りです。

  1. NAVERクラウドプラットフォームコンソールで Services > AI Services > CLOVA Studioメニューを順にクリックします。
  2. 画面左側の APIキーメニューをクリックします。
  3. APIキー画面が表示されたら、削除対象の APIキーがあるタブメニューをクリックします。
  4. 削除対象 APIキーのi_clovastudio-moreをクリックし、削除メニューをクリックします。
  5. APIキーの削除ポップアップが表示されたら、 [削除] ボタンをクリックします。
  6. APIキーの発行を参照して APIキーを新規発行します。
注意

削除した APIキーは有効ではないキーとして認識され、APIの呼び出しに使用できません。影響度を確認し、事前対策を行った上で、必要な場合にのみ行ってください。

共通の設定

CLOVA Studio APIで共通して使用されるリクエスト形式とレスポンス形式を説明します。

参考

CLOVA Studio APIキーがある場合、すぐに CLOVA Studio APIを利用することができます。ただし、サービス APIキーでサービスアプリを利用するには、申し込みの手続きが別途必要です。申し込み方法の詳細は、CLOVA Studioご利用ガイドをご参照ください。

リクエスト

共通リクエスト形式を説明します。

API URL

リクエスト API URLは次の通りです。

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

旧バージョンのリクエスト API URL(https://clovastudio.apigw.ntruss.com/)も CLOVA Studio APIの呼び出しに使用できますが、サポート中断が予定されていますので、https://clovastudio.stream.ntruss.com/の使用をお勧めします。旧バージョンのリクエスト API URLで呼び出すと、新規 APIキーによる認証ができず、生成トークンを1つずつ出力するストリーミングレスポンスを使用できません。

リクエストヘッダ

リクエストヘッダの説明は次の通りです。

フィールド 必須の有無 説明(例)
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": "50000",
    "message": "Internal Server Error"
    }
}
  • 失敗 (オープン AI互換性)
    {
"error": {
    "message": "Internal Server Error",
    "type": null,
    "param": null, //サポートしない
    "code": "50000"
    }
}

CLOVA Studio API

CLOVA Studioで提供する APIは次の通りです。

API 説明
Chat Completions v3 (テキストと画像) ビジョン/言語モデルを利用した画像解析または会話型文章を生成
Chat Completions v3 (Fuction calling) 外部関数や APIを呼び出して動的に情報を取得したり、操作を実行することができる Function calling
Chat Completions HyperCLOVA Xモデルを利用して会話型文章を生成
Completions プレイグラウンドの一般モード(LKモデル)で文章を生成
オープン AI互換性 主要 APIに対するオープン AI SDKと API互換性を提供
学習の照会 学習状況を照会
学習リストの照会 作成した学習リストを照会
学習の作成 ユーザーのデータセットを使用した学習を作成
学習の削除 作成した学習を削除
リランカー ユーザークエリと関連性の高い検索文書を活用した RAG回答を生成
RAG Reasoning RAG Reasoningモデルを活用した根拠に基づく回答を生成
トークン計算機(チャット) HCXモデル(Chat Completions API)で入力した文章のトークン数を計算
トークン計算機(チャット v3) HCXモデル(Chat Completions v3 API)で入力した文章と画像のトークン数を計算
トークン計算機(エンベディング v2) エンベディング v2で入力した文章のトークン数を計算
トークン計算機 HCX以外のモデル(Completions API)で入力した文章のトークン数を計算
スライディングウィンドウ Chat Completions利用時、最大トークン数を超える文章を処理
サマリー さまざまなオプションを適用して長文を要約
エンベディング テキストを数字で表現するベクトル化を実行
エンベディング v2 長文テキストを数字で表現するベクトル化を実行
段落分け 文章間の類似度を把握してテーマ単位で文章の段落を区切る
ルーター ユーザー入力に対してドメインとフィルタの判別を行う
スキルセット スキルセット APIを呼び出して回答を生成

CLOVA Studio関連リソース

CLOVA Studio APIについてユーザーの理解に役立つよう、さまざまな関連リソースを提供しています。

  • CLOVA Studio APIの使用方法
    • APIの概要: NAVERクラウドプラットフォームから発行された Access Key、Secret Keyの発行と確認、リクエストヘッダに必要な署名の作成方法
    • Sub Accountご利用ガイド: NAVERクラウドプラットフォームコンソールから発行されたサブアカウントの Access Key発行と確認方法
  • CLOVA Studioサービスの使用方法