--- title: "NCLUEの概要" slug: "nclue-api-overview" updated: 2026-10-08T07:23:55Z published: 2026-10-08T07:23:55Z canonical: "api.ncloud-docs.com/nclue-api-overview" --- > ## Documentation Index > Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt > Use this file to discover all available pages before exploring further. # NCLUEの概要 VPC環境で利用できます。 NCLUEは、NAVERの大規模言語モデルである HyperCLOVA Xをベースにした NCLUEモデルを活用し、さまざまな機械学習モデルを作成してさまざまなビジネス問題を解決するよう手助けする NAVERクラウドプラットフォームの SaaSサービスです。NCLUEサービスでは、Featureの作成、Taskモデルの作成と実行、ユーザープロファイリング機能を RESTful APIで提供します。 ## NCLUE共通設定 NCLUE APIで共通して使用されるリクエスト形式とレスポンス形式を説明します。 ### リクエスト 共通リクエスト形式を説明します。 #### API URL リクエスト API URLは次の通りです。 ``` https://nclue.apigw.ntruss.com/api/v1 ``` #### リクエストヘッダ ヘッダの説明は次の通りです。 | フィールド | 必須の有無 | 説明 | | --- | --- | --- | | `x-ncp-apigw-timestamp` | Required | 1970年1月1日00:00:00協定世界時(UTC)からの経過時間(ミリ秒) - API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとみなす - Unix Timestamp形式 | | `x-ncp-iam-access-key` | Required | NAVERクラウドプラットフォームから発行された Access Key - Access Keyの発行と確認: [認証キーの作成](/docs/ja/common-ncpapi#1%EC%9D%B8%EC%A6%9D%ED%82%A4%EC%83%9D%EC%84%B1)を参照 - サブアカウントの Access Key発行と確認: [サブアカウントの作成](https://guide.ncloud-docs.com/docs/ja/subaccount-use#%EC%84%9C%EB%B8%8C-%EA%B3%84%EC%A0%95-%EC%83%9D%EC%84%B1)を参照 | | `x-ncp-apigw-signature-v2` | Required | NAVERクラウドプラットフォームから発行された Access Keyとマッピングする Secret Keyと HMAC暗号化アルゴリズム(HmacSHA256)でリクエスト情報を暗号化した後、Base64でエンコードした署名 - Secret Keyの発行と確認: [認証キーの作成](/docs/ja/common-ncpapi#1%EC%9D%B8%EC%A6%9D%ED%82%A4%EC%83%9D%EC%84%B1)を参照 - 署名の作成: [シグネチャーの作成](/docs/ja/common-ncpapi#%EC%8B%9C%EA%B7%B8%EB%8B%88%EC%B2%98%EC%83%9D%EC%84%B1)を参照 | 注意 NCLUE APIの1秒当たりのリクエスト数は1tps以下に設定してください。 ### レスポンス 共通レスポンス形式を説明します。 #### レスポンスステータスコード レスポンスステータスコードの説明は次の通りです。 | HTTPステータスコード | コード | メッセージ | 説明 | | --- | --- | --- | --- | | 200 | - | success | 成功 | | 401 | 10100 | ACCESS_DENIED | 無効なアクセス | | 422 | 10101 | NAME_TOO_LONG | 名前に入力可能な文字数を超過 - 解決方法: 100文字以内で入力し、再試行 | | 409 | 10102 | DUPLICATE_NAME | 同じ名前が存在 | | 422 | 10103 | INVALID_PATH_CHARACTER | ファイルパスが使用できない記号を含む | | 422 | 10104 | INVALID_CHARACTER_IN_TRAIN_PATH | Train正解データのファイルパスが使用できない記号を含む | | 422 | 10105 | INVALID_CHARACTER_IN_TEST_PATH | Test正解データのファイルパスが使用できない記号を含む | | 404 | 10106 | PATH_NOT_FOUND | データのパスまたはファイルが存在しない | | 404 | 10107 | TRAIN_PATH_NOT_FOUND | Train正解データのパスまたはファイルが存在しない | | 404 | 10108 | TEST_PATH_NOT_FOUND | Test正解データのパスまたはファイルが存在しない | | 422 | 10109 | PERSONAL_DATA_NOT_ALLOWED | ファイルが個人情報を含む | | 422 | 10110 | PERSONAL_DATA_IN_TRAIN_FILE | Train正解データファイルが個人情報を含む | | 422 | 10111 | PERSONAL_DATA_IN_TEST_FILE | Test正解データファイルが個人情報を含む | | 422 | 10112 | TOO_MANY_KEYWORDS | 入力可能な属性キーワードの文字列の長さの合計が制限を超過 - 解決方法: 文字列の長さの合計を1000文字以内にして入力し、再試行 | | 409 | 10113 | INCOMPATIBLE_MODEL | Featureと Taskが互換性を持たない | | 409 | 10114 | FEATURE_PROCESSING | リクエストを処理できない - 解決方法: Featureの状態が待機中か作成中の場合、作成完了後に再試行 | | 409 | 10115 | TASK_PROCESSING | リクエストを処理できない - 解決方法: Taskの状態が待機中か作成中の場合、作成完了後に再試行 | | 409 | 10116 | RUN_PROCESSING | リクエストを処理できない - 解決方法: Runの状態が待機中か作成中の場合、作成完了後に再試行 | | 409 | 10117 | PROFILE_PROCESSING | リクエストを処理できない - 解決方法: Profileの状態が待機中か作成中の場合、作成完了後に再試行 | | 422 | 10118 | KEYWORD_REQUIRED | キーワードが入力されていない | | 422 | 10119 | STORAGE_FULL | データの空き容量不足 | | 422 | 10121 | EMPTY_CONTENT_IN_PATH | 正解データのパスまたはファイルが空である | | 422 | 10122 | EMPTY_CONTENT_IN_TRAIN_PATH | Train正解データのパスまたはファイルが空である | | 422 | 10123 | EMPTY_CONTENT_IN_TEST_PATH | Test正解データのパスまたはファイルが空である | | 404 | 10124 | PROFILE_NOT_FOUND | プロファイルデータが存在しない | | 422 | 10130 | INVALID_RESULT_FILE_PATH | 異常なファイルパスが入力される | | 422 | 10131 | OBJECT_STORAGE_ACCESS_DENIED | Object Storageバケットにアクセスできない - 解決方法: Object Storageバケットへのアクセス権限を付与し、再試行 | | 404 | 10132 | OBJECT_STORAGE_ACCOUNT_REQUIRED | Object Storageサービスご利用の申し込みが必要 | | 422 | 10133 | INVALID_LIMIT | `limit`に入力可能な値を超過 - 解決方法: 1~100以内で入力し、再試行 | | 409 | 10134 | FEATURE_IN_USE | Featureを削除できない - 解決方法: Featureで作成中のジョブを完了し、再試行 | | 409 | 10135 | TASK_IN_USE | Taskを削除できない - 解決方法: Taskで作成中のジョブを完了し、再試行 | | 404 | 10136 | BUCKET_NOT_FOUND | 存在しない Object Storageのバケット名が入力される | | 422 | 10137 | NAME_REQUIRED | Feature、Taskなどを作成する APIの呼び出し時に`name`が抜けている | | 422 | 10138 | INVALID_INDEX | Feature、Taskなどリストを照会する APIの呼び出し時、`index`値が0より小さいか、有効な値ではない | | 422 | 10139 | EMPTY_PATH | Feature、Taskなどを作成する APIの呼び出し時にファイルパスが抜けている | | 422 | 10141 | UNEXPECTED_FILE_TYPE | Featureの作成時、シーケンスデータファイル形式が無効か、個人情報が含まれている。データスキーマおよび内容ルールの整合性は、この段階では確認しない | | 422 | 10142 | UNEXPECTED_FILE_TYPE_TRAIN | Taskモデルの作成時、Trainの正解データファイル形式が無効か、個人情報が含まれている。データスキーマおよび内容ルールの整合性は、この段階では確認しない | | 422 | 10143 | UNEXPECTED_FILE_TYPE_TEST | Taskモデルの作成時、Testの正解データファイル形式が無効か、個人情報が含まれている。データスキーマおよび内容ルールの整合性は、この段階では確認しない | | 422 | 10144 | INVALID_LABEL_TYPE | Taskモデルの作成時、正解データパスがファイルでない場合に発生(ディレクトリ不可) | | 422 | 10145 | INVALID_TRAIN_LABEL_TYPE | Taskモデルの作成時、Train正解データパスがファイルでない場合に発生(ディレクトリ不可) | | 422 | 10146 | INVALID_TEST_LABEL_TYPE | Taskモデルの作成時、Test正解データパスがファイルでない場合に発生(ディレクトリ不可) | | 422 | 10147 | DEPRECATED_MODEL_FEATURE | Deprecatedされた NCLUEモデルで作成した Feature | | 422 | 10148 | DEPRECATED_MODEL_FEATURE_TRAIN | Deprecatedされた NCLUEモデルで作成した Train Feature | | 422 | 10149 | DEPRECATED_MODEL_FEATURE_TEST | Deprecatedされた NCLUEモデルで作成した Test Feature | | 422 | 10150 | DEPRECATED_MODEL_TASK | Deprecatedされた NCLUEモデルで作成した Task | 参考 NAVERクラウドプラットフォームで共通して使用されるレスポンスステータスコードの詳細は、[Ncloud APIのレスポンスステータスコード](/docs/ja/common-ncpapi#3%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C)をご参照ください。 ## NCLUE API NCLUEサービスで提供する APIの説明は次の通りです。 | API | 説明 | | --- | --- | | [Featureの照会](/docs/ja/nclue-getfeature) | NCLUE Featureの詳細情報を照会 | | [Featureリストの照会](/docs/ja/nclue-getfeaturelist) | NCLUE Featureリストを照会 | | [Featureの作成](/docs/ja/nclue-postfeature) | シーケンスデータセットを活用して NCLUE Featureを作成 | | [Featureの削除](/docs/ja/nclue-deletefeature) | NCLUE Featureを削除 | | [Taskの照会](/docs/ja/nclue-gettask) | Task Modelの詳細情報を照会 | | [Taskリストの照会](/docs/ja/nclue-gettasklist) | Task Modelリストを照会 | | [Taskの作成](/docs/ja/nclue-posttask) | 正解データセットを活用して Task Modelを作成 | | [Taskの削除](/docs/ja/nclue-deletetask) | Task Modelを削除 | | [Task Runの照会](/docs/ja/nclue-gettaskrun) | Task Modelの実行結果を照会 | | [Task Runリストの照会](/docs/ja/nclue-gettaskrunlist) | Task Modelの Runリストを照会 | | [Task Runの作成](/docs/ja/nclue-posttaskrun) | ユーザー Featureと Task Modelを活用して Runを作成 | | [Task Runの削除](/docs/ja/nclue-deletetaskrun) | Task Modelの Runを削除 | | [Shopping Intentの照会](/docs/ja/nclue-getshoppingintent) | Shopping Intentの Profileの詳細情報を照会 | | [Shopping Intentリストの照会](/docs/ja/nclue-getshoppingintentlist) | Shopping Intentの Profileリストを照会 | | [Shopping Intentの作成](/docs/ja/nclue-postshoppingintent) | Shopping Intentの Profileを作成 | | [Shopping Intentの削除](/docs/ja/nclue-deleteshoppingintent) | Shopping Intentの Profileを削除 | | [Shopping Intentのダウンロード](/docs/ja/nclue-getshoppingintentdownload) | Shopping Intentの Profile結果をダウンロード | | [Custom Attributesの照会](/docs/ja/nclue-getcustomattributes) | Custom Attributesの Profileの詳細情報を照会 | | [Custom Attributesリストの照会](/docs/ja/nclue-getcustomattributeslist) | Custom Attributesの Profileリストを照会 | | [Custom Attributesの作成](/docs/ja/nclue-postcustomattributes) | Custom Attributesの Profileを作成 | | [Custom Attributesの削除](/docs/ja/nclue-deletecustomattributes) | Custom Attributesの Profileを削除 | ## NCLUE関連リソース NCLUE APIについてユーザーの理解に役立つよう、さまざまな関連リソースを提供しています。 - NCLUE APIの使用方法 - [署名(シグネチャー)の作成](/docs/ja/common-ncpapi#1%EC%9D%B8%EC%A6%9D%ED%82%A4%EC%83%9D%EC%84%B1): リクエストヘッダに追加する署名の作成方法 - [API Gatewayご利用ガイド](https://guide.ncloud-docs.com/docs/ja/apigw-apigw-1): リクエストヘッダに追加する API Keyを発行 - [Sub Accountご利用ガイド](https://guide.ncloud-docs.com/docs/ja/subaccount-overview): リクエストヘッダに追加する Access Keyの発行方法 - [Ncloudの共通レスポンスステータスコード](/docs/ja/common-ncpapi#3%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C): NCLUEサービスで使用される NAVERクラウドプラットフォームの共通レスポンスステータスコード情報 - NCLUEサービスの使用方法 - [NCLUEご利用ガイド](https://guide.ncloud-docs.com/docs/ja/nclue-overview): NAVERクラウドプラットフォームコンソールで NCLUEを使用する方法 - [Ncloud利用環境ガイド](https://guide.ncloud-docs.com/docs/ja/environment-environment-1-1): VPC、Classic環境およびサポートに関する利用ガイド - [料金の紹介、特徴、詳細機能](https://www.ncloud.com/product/aiService/nclue): NCLUEサービスの料金体系、特長と詳細機能のサマリー - [サービスの最新情報](https://www.ncloud.com/intro/news): NCLUEに関する最新情報 - [よくある質問](https://www.ncloud.com/support/faq/prod?categoryCode2=AI&categoryCode3=SV_0265&page=1): NCLUEユーザーからよく寄せられる質問とその回答 - [お問い合わせ](https://www.ncloud.com/support/question/service): APIガイドだけでは不明な点が解消されない場合、直接問い合わせ