GET
/
v1
/
rag42
/
collections
/
{collection_id}
/
documents
문서 목록
curl --request GET \
  --url https://api.clovastudio.go.kr/v1/rag42/collections/{collection_id}/documents \
  --header 'Authorization: Bearer <token>'
{
  "status": {
    "code": "20000",
    "message": "OK"
  },
  "result": {
    "documents": [
      {
        "document_id": "ed5754eec78e4e0783ce075549ccadaa",
        "document_name": "2024년_업무추진계획.pdf",
        "file_name": "2024년_업무추진계획.pdf",
        "file_size": 2458624,
        "file_extension": "pdf",
        "search_status": "ACTIVE",
        "upload_status": "SUCCESS",
        "processing_status": "COMPLETED",
        "chunk_count": 15,
        "created_at": "2024-10-18T12:00:00Z",
        "updated_at": "2024-10-18T12:00:00Z",
        "external_id": "DOC-2024-001"
      },
      {
        "document_id": "f9d4ed5bda3548a5882a4cb2668f705f",
        "document_name": "행정규칙_개정안.pdf",
        "file_name": "행정규칙_개정안.pdf",
        "file_size": 1847296,
        "file_extension": "pdf",
        "search_status": "ACTIVE",
        "upload_status": "SUCCESS",
        "processing_status": "COMPLETED",
        "chunk_count": 8,
        "created_at": "2024-10-17T15:30:00Z",
        "updated_at": "2024-10-17T15:30:00Z",
        "external_id": "DOC-2024-002"
      }
    ],
    "total_count": 2
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
CSG-TENANT-ID
string | null

Clova Studio Gov 테넌트 ID

​
X-CSG-TENANT-ID
string | null

Clova Studio Gov 테넌트 ID (레거시)

Path Parameters

​
collection_id
string
required

컬렉션 ID (project_id)

Examples:

"ef7483af16d84818a59dcbcf8b587b93"

"a1b2c3d4e5f6789012345678901234ab"

Query Parameters

​
size
integer | null
default:20

반환할 문서 수

Required range: 1 <= x <= 100
​
from
integer | null
default:0

시작 위치 (0부터)

Required range: x >= 0
​
sort
string | null
default:updated_at:desc

정렬 옵션 (name:asc, name:desc, updated_at:asc, updated_at:desc, file_size:asc, file_size:desc)

​
upload_status
string | null

업로드 상태 필터 (SUCCESS, PENDING, FAILED 중 하나 또는 쉼표로 여러 개, 예: SUCCESS,PENDING)

Examples:

"SUCCESS"

"FAILED"

"SUCCESS,PENDING"

Response

문서 목록 조회 성공

문서 목록 조회 응답

​
status
object
required

응답 상태

​
result
object
required

문서 목록 조회 결과