--- title: "NCLUE 개요" slug: "nclue-api-overview" updated: 2026-10-19T10:13:25Z published: 2026-10-20T03:00:25Z 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는 네이버의 대규모 언어 모델인 HyperCLOVA X에 기반한 NCLUE 모델을 활용하여 다양한 기계 학습 모델을 생성하고 여러 비즈니스 문제를 해결할 수 있도록 돕는 네이버 클라우드 플랫폼의 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 | 네이버 클라우드 플랫폼에서 발급받은 Access Key - Access Key 발급 및 확인: [인증키 생성](/docs/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/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 | 네이버 클라우드 플랫폼에서 발급받은 Access Key에 맵핑되는 Secret Key 및 HMAC 암호화 알고리즘(HmacSHA256)으로 요청 정보를 암호화한 후 Base64로 인코딩한 서명 - Secret Key 발급 및 확인: [인증키 생성](/docs/common-ncpapi#1%EC%9D%B8%EC%A6%9D%ED%82%A4%EC%83%9D%EC%84%B1) 참조 - 서명 생성: [시그니처 생성](/docs/common-ncpapi#%EC%8B%9C%EA%B7%B8%EB%8B%88%EC%B2%98%EC%83%9D%EC%84%B1) 참조 | 주의 NCLUE API의 초당 요청 수는 1 tps 이하로 설정해 주십시오. ### 응답 공통 응답 형식을 설명합니다. #### 응답 상태 코드 응답 상태 코드에 대한 설명은 다음과 같습니다. | 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 | 참고 네이버 클라우드 플랫폼에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 [Ncloud API 응답 상태 코드](/docs/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/nclue-getfeature) | NCLUE Feature의 상세 정보 조회 | | [Feature 목록 조회](/docs/nclue-getfeaturelist) | NCLUE Feature의 목록 조회 | | [Feature 생성](/docs/nclue-postfeature) | 시퀀스 데이터셋을 활용하여 NCLUE Feature 생성 | | [Feature 삭제](/docs/nclue-deletefeature) | NCLUE Feature 삭제 | | [Task 조회](/docs/nclue-gettask) | Task Model의 상세 정보 조회 | | [Task 목록 조회](/docs/nclue-gettasklist) | Task Model의 목록 조회 | | [Task 생성](/docs/nclue-posttask) | 정답 데이터셋을 활용하여 Task Model 생성 | | [Task 삭제](/docs/nclue-deletetask) | Task Model 삭제 | | [Task Run 조회](/docs/nclue-gettaskrun) | Task Model의 실행 결과 조회 | | [Task Run 목록 조회](/docs/nclue-gettaskrunlist) | Task Model의 Run 목록 조회 | | [Task Run 생성](/docs/nclue-posttaskrun) | 사용자 Feature와 Task Model을 활용하여 Run 생성 | | [Task Run 삭제](/docs/nclue-deletetaskrun) | Task Model의 Run 삭제 | | [Shopping Intent 조회](/docs/nclue-getshoppingintent) | Shopping Intent의 Profile 상세 정보 조회 | | [Shopping Intent 목록 조회](/docs/nclue-getshoppingintentlist) | Shopping Intent의 Profile 목록 조회 | | [Shopping Intent 생성](/docs/nclue-postshoppingintent) | Shopping Intent의 Profile 생성 | | [Shopping Intent 삭제](/docs/nclue-deleteshoppingintent) | Shopping Intent의 Profile 삭제 | | [Shopping Intent 다운로드](/docs/nclue-getshoppingintentdownload) | Shopping Intent의 Profile 결과 다운로드 | | [Custom Attributes 조회](/docs/nclue-getcustomattributes) | Custom Attributes의 Profile 상세 정보 조회 | | [Custom Attributes 목록 조회](/docs/nclue-getcustomattributeslist) | Custom Attributes의 Profile 목록 조회 | | [Custom Attributes 생성](/docs/nclue-postcustomattributes) | Custom Attributes의 Profile 생성 | | [Custom Attributes 삭제](/docs/nclue-deletecustomattributes) | Custom Attributes의 Profile 삭제 | ## NCLUE 연관 리소스 NCLUE API에 대한 사용자의 이해를 돕기 위해 다양한 연관 리소스를 제공하고 있습니다. - NCLUE API 사용 방법 - [서명(시그니처) 생성](/docs/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/apigw-apigw-1): 요청 헤더에 추가할 API Key 발급 - [Sub Account 사용 가이드](https://guide.ncloud-docs.com/docs/subaccount-overview): 요청 헤더에 추가할 Access Key 발급 방법 - [Ncloud 공통 응답 상태 코드](/docs/common-ncpapi#3%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C): NCLUE 서비스에서 사용하는 네이버 클라우드 플랫폼의 공통 응답 상태 코드 정보 - NCLUE 서비스 사용 방법 - [NCLUE 사용 가이드](https://guide.ncloud-docs.com/docs/nclue-overview): 네이버 클라우드 플랫폼 콘솔에서 NCLUE를 사용하는 방법 - [Ncloud 사용 환경 가이드](https://guide.ncloud-docs.com/docs/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 가이드를 통해서도 궁금증이 해결되지 않는 경우 직접 문의