---
title: "NCLUE overview"
slug: "nclue-api-overview"
updated: 2026-10-08T04:23:16Z
published: 2026-10-08T04:23:16Z
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 overview

Available in VPC

NCLUE is a NAVER Cloud Platform SaaS service that helps users create various machine learning models and solve various business problems by using the NCLUE model based on HyperCLOVA X, NAVER's large-scale language model. The NCLUE service provides RESTful APIs for feature creation, task model creation and execution, and user profiling.

## Common NCLUE settings

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

### Request

The following describes the common request format:

#### API URL

The request API URL is as follows:

```
https://nclue.apigw.ntruss.com/api/v1
```

#### Request headers

The following describes the headers.

| Field | Required | Description |
| --- | --- | --- |
| `x-ncp-apigw-timestamp` | Required | This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC. - Request is considered invalid if the timestamp differs from the current time by more than 5 minutes. - Unix timestamp format. |
| `x-ncp-iam-access-key` | Required | Access key issued from NAVER Cloud Platform - Issue or view access key: See [Create authentication key](/docs/en/common-ncpapi#1%EC%9D%B8%EC%A6%9D%ED%82%A4%EC%83%9D%EC%84%B1). - Issue or view access key for sub account: See [Create sub account](https://guide.ncloud-docs.com/docs/en/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 | Base64-encoded signature generated by encrypting the request information with the secret key mapped to the access key, using the HmacSHA256 algorithm - Issue and check secret key: See [Create authentication key](/docs/en/common-ncpapi#1%EC%9D%B8%EC%A6%9D%ED%82%A4%EC%83%9D%EC%84%B1). - Create signature: See [Create signature](/docs/en/common-ncpapi#%EC%8B%9C%EA%B7%B8%EB%8B%88%EC%B2%98%EC%83%9D%EC%84%B1). |

              Caution

              

Set the number of requests per second for the NCLUE API to 1 tps or less.

### Response

The following describes the common response format:

#### Response status codes

The following describes the response status codes:

| HTTP status code | Code | Message | Description |
| --- | --- | --- | --- |
| 200 | - | success | Succeeded |
| 401 | 10100 | ACCESS_DENIED | Invalid access |
| 422 | 10101 | NAME_TOO_LONG | Number of characters allowed in name exceeded - Solution: Enter less than 100 characters and try again. |
| 409 | 10102 | DUPLICATE_NAME | Same name exists. |
| 422 | 10103 | INVALID_PATH_CHARACTER | The file path contains an invalid special character. |
| 422 | 10104 | INVALID_CHARACTER_IN_TRAIN_PATH | The train correct answer data file path contains an invalid special character. |
| 422 | 10105 | INVALID_CHARACTER_IN_TEST_PATH | The test correct answer data file path contains an invalid special character. |
| 404 | 10106 | PATH_NOT_FOUND | The data path or file does not exist. |
| 404 | 10107 | TRAIN_PATH_NOT_FOUND | The train correct answer data path or file does not exist. |
| 404 | 10108 | TEST_PATH_NOT_FOUND | The test correct answer data path or file does not exist. |
| 422 | 10109 | PERSONAL_DATA_NOT_ALLOWED | The file contains personal information. |
| 422 | 10110 | PERSONAL_DATA_IN_TRAIN_FILE | The train correct answer data file contains personal information. |
| 422 | 10111 | PERSONAL_DATA_IN_TEST_FILE | The test correct answer data file contains personal information. |
| 422 | 10112 | TOO_MANY_KEYWORDS | The total string length of the inputable attribute keyword is exceeded. - Solution: Enter the total string length within 1000 characters and try again. |
| 409 | 10113 | INCOMPATIBLE_MODEL | The feature and the task are incompatible. |
| 409 | 10114 | FEATURE_PROCESSING | Requested job cannot be processed. - Solution: If the status of the feature is pending or creating, retry after creation is complete. |
| 409 | 10115 | TASK_PROCESSING | Requested job cannot be processed. - Solution: If the status of the task is pending or creating, retry after creation is complete. |
| 409 | 10116 | RUN_PROCESSING | Requested job cannot be processed. - Solution: If the status of the run is pending or creating, retry after creation is complete. |
| 409 | 10117 | PROFILE_PROCESSING | Requested job cannot be processed. - Solution: If the status of the profile is pending or creating, retry after creation is complete. |
| 422 | 10118 | KEYWORD_REQUIRED | Keyword not entered |
| 422 | 10119 | STORAGE_FULL | Insufficient data storage space |
| 422 | 10121 | EMPTY_CONTENT_IN_PATH | The correct answer data path or file is empty. |
| 422 | 10122 | EMPTY_CONTENT_IN_TRAIN_PATH | The train correct answer data path or file is empty. |
| 422 | 10123 | EMPTY_CONTENT_IN_TEST_PATH | The test correct answer data path or file is empty. |
| 404 | 10124 | PROFILE_NOT_FOUND | No profile data exists. |
| 422 | 10130 | INVALID_RESULT_FILE_PATH | An abnormal file path is entered. |
| 422 | 10131 | OBJECT_STORAGE_ACCESS_DENIED | Unable to access the Object Storage bucket - Solution: Retry after granting access to the Object Storage bucket. |
| 404 | 10132 | OBJECT_STORAGE_ACCOUNT_REQUIRED | Need to subscribe to the Object Storage service. |
| 422 | 10133 | INVALID_LIMIT | Number of characters allowed in `limit` exceeded - Solution: Enter between 1 to 100 characters and try again. |
| 409 | 10134 | FEATURE_IN_USE | Unable to delete feature - Solution: Try again after completing the job being created with the feature. |
| 409 | 10135 | TASK_IN_USE | Unable to delete task - Solution: Try again after completing the job being created with the task. |
| 404 | 10136 | BUCKET_NOT_FOUND | An Object Storage bucket name that does not exist is entered. |
| 422 | 10137 | NAME_REQUIRED | `name` is missing from API calls that create features, tasks, etc. |
| 422 | 10138 | INVALID_INDEX | The `index` value is less than 0 or not a normal value when making API calls to get lists of features, tasks, etc. |
| 422 | 10139 | EMPTY_PATH | Input file path is empty for API calls that create features, tasks, etc. |
| 422 | 10141 | UNEXPECTED_FILE_TYPE | During feature creation, there is an error in the sequence data file format or it contains personal information. Data schema and content rule consistency are not verified at this stage. |
| 422 | 10142 | UNEXPECTED_FILE_TYPE_TRAIN | During task model creation, there is an error in the format of the train correct answer data file or it contains personal information. Data schema and content rule consistency are not verified at this stage. |
| 422 | 10143 | UNEXPECTED_FILE_TYPE_TEST | During task model creation, there is an error in the format of the test correct answer data file or it contains personal information. Data schema and content rule consistency are not verified at this stage. |
| 422 | 10144 | INVALID_LABEL_TYPE | It occurs if the correct answer data path is not a file when creating a task model (can't be a directory). |
| 422 | 10145 | INVALID_TRAIN_LABEL_TYPE | It occurs when train correct answer data path is not a file when creating a task model (can't be a directory). |
| 422 | 10146 | INVALID_TEST_LABEL_TYPE | It occurs when test correct answer data path is not a file when creating a task model (can't be a directory). |
| 422 | 10147 | DEPRECATED_MODEL_FEATURE | Feature created with a deprecated NCLUE model |
| 422 | 10148 | DEPRECATED_MODEL_FEATURE_TRAIN | Train feature created with a deprecated NCLUE model |
| 422 | 10149 | DEPRECATED_MODEL_FEATURE_TEST | Test feature created with a deprecated NCLUE model |
| 422 | 10150 | DEPRECATED_MODEL_TASK | Task created with a deprecated NCLUE model |

              Note

              

For information about the response status codes common to NAVER Cloud Platform, see [Ncloud API response status codes](/docs/en/common-ncpapi#3%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C).

## NCLUE API

The following describes the APIs provided by the NCLUE service.

| API | Description |
| --- | --- |
| [Get feature](/docs/en/nclue-getfeature) | Get NCLUE feature details. |
| [Get feature list](/docs/en/nclue-getfeaturelist) | Get NCLUE feature list. |
| [Create feature](/docs/en/nclue-postfeature) | Create NCLUE feature using sequence dataset. |
| [Delete feature](/docs/en/nclue-deletefeature) | Delete NCLUE feature. |
| [Get task](/docs/en/nclue-gettask) | Get task model details. |
| [Get task list](/docs/en/nclue-gettasklist) | Get task model list. |
| [Create task](/docs/en/nclue-posttask) | Create task model using correct answer dataset. |
| [Delete task](/docs/en/nclue-deletetask) | Delete task model. |
| [Get task run](/docs/en/nclue-gettaskrun) | Get task model execution results. |
| [Get task run list](/docs/en/nclue-gettaskrunlist) | Get task model run list. |
| [Create task run](/docs/en/nclue-posttaskrun) | Create run using user feature and task model. |
| [Delete task run](/docs/en/nclue-deletetaskrun) | Delete task model run. |
| [Get shopping intent](/docs/en/nclue-getshoppingintent) | Get profile details of shopping intent. |
| [Get shopping intent list](/docs/en/nclue-getshoppingintentlist) | Get profile list of shopping intent. |
| [Create shopping intent](/docs/en/nclue-postshoppingintent) | Create profile of shopping intent. |
| [Delete shopping intent](/docs/en/nclue-deleteshoppingintent) | Delete profile of shopping intent. |
| [Download shopping intent](/docs/en/nclue-getshoppingintentdownload) | Download profile result of shopping intent. |
| [Get custom attributes](/docs/en/nclue-getcustomattributes) | Get profile details of custom attributes. |
| [Get custom attributes list](/docs/en/nclue-getcustomattributeslist) | Get profile list of custom attributes. |
| [Create custom attributes](/docs/en/nclue-postcustomattributes) | Create profile of custom attributes. |
| [Delete custom attributes](/docs/en/nclue-deletecustomattributes) | Delete profile of custom attributes. |

## NCLUE related resources

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

- How to use NCLUE APIs
  - [Create signature](/docs/en/common-ncpapi#1%EC%9D%B8%EC%A6%9D%ED%82%A4%EC%83%9D%EC%84%B1): Learn how to create the signature to add to your request headers.
  - [API Gateway user guide](https://guide.ncloud-docs.com/docs/en/apigw-apigw-1): How to issue the API key to be added to the request header
  - [Sub Account user guide](https://guide.ncloud-docs.com/docs/en/subaccount-overview): Learn how to issue the access key to add to your request headers.
  - [Common Ncloud response status codes](/docs/en/common-ncpapi#3%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C): Review the shared response status codes used across NAVER Cloud Platform.
- How to use NCLUE service
  - [NCLUE user guide](https://guide.ncloud-docs.com/docs/en/nclue-overview): Learn how to use NCLUE in the NAVER Cloud Platform console.
  - [Ncloud user environment guide](https://guide.ncloud-docs.com/docs/en/environment-environment-1-1): Explore VPC and Classic environments and supported services.
  - [Pricing and features](https://www.ncloud.com/product/aiService/nclue): View pricing details and key capabilities.
  - [Latest announcements](https://www.ncloud.com/intro/news): Stay informed about NCLUE service updates and news.
  - [FAQs](https://www.ncloud.com/support/faq/prod?categoryCode2=AI&categoryCode3=SV_0265&page=1): Get answers to common NCLUE questions.
  - [Contact Support](https://www.ncloud.com/support/question/service): Get help if you can't find what you need in the API guide.