---
title: "API 문서 조회"
slug: "apigateway-getdocuments"
tags: ["API Gateway", "Document", "API"]
updated: 2026-09-17T09:15:58Z
published: 2026-09-17T09:15:58Z
canonical: "api.ncloud-docs.com/apigateway-getdocuments"
---

> ## 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.

# API 문서 조회

<p class="platform-info type-classic-vpc">Classic/VPC 환경에서 이용 가능합니다.</p>

Stage에 배포된 API 설명서를 조회합니다. 직접 생성한 API에서만 사용할 수 있습니다.

## 요청<a name="요청"></a>
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
| 메서드 | URI |
| :--- | :--- |
| GET | /api/v1/products/{product-id}/apis/{api-id}/documents |

### 요청 헤더<a name="요청헤더"></a>
API Gateway에서 공통으로 사용하는 헤더에 대한 정보는 [API Gateway 요청 헤더](/docs/ai-application-service-apigateway#요청헤더)를 참조해 주십시오.

                 
### 요청 경로 파라미터<a name="요청경로파라미터"></a>
요청 경로 파라미터에 대한 설명은 다음과 같습니다.

| 필드 | 타입 | 필수 여부 | 설명 |            
| :--- | :--- | :--- | :--- |
| `product-id` | String | Required | API가 속한 Product ID<ul><li>1~10자</li><li>[Product 목록 조회](/docs/apigateway-product-getproductlist) 참조</li></ul> |
| `api-id` | String | Required | 문서를 조회할 API의 ID<ul><li>1~10자</li><li>[API 조회](/docs/apigateway-api-apis) 참조</li></ul> |

   
### 요청 예시<a name="요청예시"></a>
요청 예시는 다음과 같습니다. 

```shell
curl --location --request GET 'https://apigateway.apigw.ntruss.com/api/v1/products/w1k03m9zo9/apis/cvcohvd2xj/documents' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json'
```

## 응답<a name="응답"></a>
응답 형식을 설명합니다.
    
### 응답 구문<a name="응답구문"></a>
응답 구문은 다음과 같습니다.

```json
{
  "apiId" : "apiId",
  "documentMd" : "documentMd",
  "tenantId" : "tenantId",
  "modifier" : "modifier"  
}
```
    
### 응답 상태 코드 <a name="응답상태코드"></a>
API Gateway에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 [API Gateway 응답 상태 코드](/docs/ai-application-service-apigateway#응답상태코드)를 참조해 주십시오.

### 응답 예시<a name="응답예시"></a>
응답 예시는 다음과 같습니다. 
```json
{
    "apiId": "cvcohvd2xj",
    "documentMd": "API 문서의 설명서",
    "tenantId": "********65ec41039ce6668c2058b8a9",
    "modifier": "********-7fcd-11ec-a6ba-246e9659184c"
}
```