---
title: "API文書の照会"
slug: "apigateway-getdocuments"
updated: 2026-09-17T09:57:24Z
published: 2026-09-17T09:57:24Z
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文書の照会

Classic/VPC環境で利用できます。

Stageに公開された API説明書を照会します。直接作成した APIでのみ使用できます。

## リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

| メソッド | URI |
| --- | --- |
| GET | /api/v1/products/{product-id}/apis/{api-id}/documents |

### リクエストヘッダ

API Gatewayで共通して使用されるヘッダの詳細は、[API Gatewayのリクエストヘッダ](/docs/ja/ai-application-service-apigateway#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%94)をご参照ください。

### リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `product-id` | String | Required | APIが属する Product ID - 1~10文字 - [Productリストの照会](/docs/ja/apigateway-product-getproductlist)を参照 |
| `api-id` | String | Required | 文書を照会する対象 APIの ID - 1~10文字 - [APIの照会](/docs/ja/apigateway-api-apis)を参照 |

### リクエスト例

リクエストのサンプルコードは次の通りです。

```
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'
```

## レスポンス

レスポンス形式を説明します。

### レスポンス構文

レスポンス構文は次の通りです。

```
{
  "apiId" : "apiId",
  "documentMd" : "documentMd",
  "tenantId" : "tenantId",
  "modifier" : "modifier"  
}
```

### レスポンスステータスコード

API Gatewayで共通して使用されるレスポンスステータスコードの詳細は、[API Gatewayのレスポンスステータスコード](/docs/ja/ai-application-service-apigateway#%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C)をご参照ください。

### レスポンス例

レスポンスのサンプルコードは次の通りです。

```
{
    "apiId": "cvcohvd2xj",
    "documentMd": "API文書の説明書",
    "tenantId": "********65ec41039ce6668c2058b8a9",
    "modifier": "********-7fcd-11ec-a6ba-246e9659184c"
}
```