RAG overview

Available in VPC

RAG (Retrieval Augmented Generation) is a NAVER Cloud Platform service that enables LLMs to generate accurate, customized answers by referencing your data. The RAG API provides RESTful endpoints for generating answers to questions and managing the documents and files used as reference sources.

API key

The RAG API authenticates requests using API keys. Each account is issued a unique key, which must be included in the request header when calling the API. Therefore, to use the RAG API, you must first obtain an API key.

Issue API key

You can issue API keys from the NAVER Cloud Platform console. To issue them:

1. In the NAVER Cloud Platform console, navigate to Menu > Services > AI Services > RAG > Services.
2. Click [Manage API key] in the service table.
3. In the Manage API key page, click [Issue API key].
4. In the Issue API key popup, click [Issue].
   • In the Copy API key popup, copy the issued API key.

Set API security

If an API key is compromised, unauthorized parties could access your RAG resources. Take the following precautions to protect your keys.

Delete and reissue API key

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

1. In the NAVER Cloud Platform console, navigate to Menu > Services > AI Services > RAG.
2. Click [Manage API key] in the service table.
3. In the Manage API key page, click of the API key to delete, and then click Delete.
4. In the Delete API key popup, click [Delete].
5. See Issue API key and issue a new API key.

Common RAG settings

This section covers the request and response formats used across RAG APIs.

Request

The following describes the common request format:

API URL

The request API URL is as follows:

https://kr-pub-gateway.rag.naverncp.com

Request headers

The following describes the request headers:

Response

The following describes the common response format:

Response body

The response body includes the following data:

responseError
responseError contains details about a failed API call. The following describes the responseError fields:

Response status codes

The following describes the response status codes:

Response example

For successful response examples, see each API's specification page. The following shows a sample error response:

{
    "code": 50008,
    "message": "Model not found"
}

RAG APIs

This section describes the APIs provided by RAG.

Chat

The following describes the Chat-related APIs:

Document

The following describes the Document-related APIs:

File

The following describes the File-related APIs:

RAG related resources

These resources provide additional context and support for RAG APIs.

• RAG service guides
  • RAG user guide: Learn how to use RAG in the NAVER Cloud Platform console.
  • Ncloud user environment guide: Explore VPC and Classic environments and supported services.