> ## Documentation Index
> Fetch the complete documentation index at: https://docs.acedata.cloud/llms.txt
> Use this file to discover all available pages before exploring further.

# AceDataCloud プラットフォームのドキュメント一覧を取得

> Platform API guide - Ace Data Cloud

ページネーションにより、現在のサイトで閲覧可能な開発者ドキュメントを返します。検索、インデックス作成、またはクライアント側でのナビゲーション構築に使用できます。一覧には現在、各ドキュメントの `content` とネストされた親情報が含まれており、レスポンスが大きくなる可能性があります。

## API 概要

| 項目 | 内容 |
| - | - |
| メソッド | `GET` |
| URL | `https://platform.acedata.cloud/api/v1/documents/` |
| 認証 | 公開；管理者以外は private ドキュメントを閲覧できない |
| ページネーション | `count` + `items` |

## クエリパラメータ

| パラメータ | 型 | 必須 | デフォルト | 説明 |
| - | - | - | - | - |
| `id` | UUID | いいえ | — | ドキュメント ID でフィルタリング；繰り返しパラメータをサポート |
| `private` | boolean | いいえ | — | private 状態でフィルタリング；管理者以外は依然として非公開ドキュメントを閲覧できない |
| `type` | string | いいえ | — | Document の実際の `type` 値で完全一致フィルタリング |
| `tag` | string | いいえ | — | タグでフィルタリング |
| `limit` | integer | いいえ | 10 | 1 ページあたりの件数、最大 100 |
| `offset` | integer | いいえ | 0 | ページネーションのオフセット |
| `ordering` | string | いいえ | `rank` | `rank` によるソートのみ対応；接頭辞 `-` は降順を示す |

現在の一覧 API は `alias` または `parent_id` によるフィルタリングをサポートしていません。alias が判明している場合は直接[ドキュメント詳細](https://platform.acedata.cloud/documents/platform-document-detail)を呼び出してください；ツリー型ナビゲーションを構築する場合は、一度ページネーションで取得した後、各項目の `parent.id` を使用してクライアント側でグループ化してください。

## リクエスト例

```shell theme={null}
curl --get 'https://platform.acedata.cloud/api/v1/documents/' \
  --data-urlencode 'tag=development' \
  --data-urlencode 'limit=100' \
  --data-urlencode 'ordering=rank' \
  -H 'Accept: application/json'
```

```python theme={null}
import requests

response = requests.get(
    "https://platform.acedata.cloud/api/v1/documents/",
    params={"tag": "development", "limit": 100, "offset": 0},
    timeout=30,
)
response.raise_for_status()
data = response.json()
for document in data["items"]:
    parent = document.get("parent") or {}
    print(document["alias"], parent.get("alias"))
```

## レスポンス構造

```json theme={null}
{
  "count": 1,
  "items": [
    {
      "id": "00000000-0000-4000-8000-000000000001",
      "alias": "platform-token",
      "name": "Document of Platform Token",
      "title": "管理 AceDataCloud 平台账户令牌（Account Token）",
      "content": "# 管理 AceDataCloud 平台账户令牌……",
      "type": "Text",
      "private": false,
      "primary_only": false,
      "rank": 2400,
      "tags": [
        "development"
      ],
      "parent": {
        "id": "00000000-0000-4000-8000-000000000002",
        "alias": "platform",
        "title": "AceDataCloud 平台"
      },
      "sibling": null,
      "api_id": null,
      "proxy_id": null,
      "api_method": null,
      "metadata": null,
      "created_at": "2026-01-01T00:00:00Z",
      "updated_at": "2026-01-01T00:00:00Z"
    }
  ]
}
```

一覧では `DocumentIndexSerializer` を使用しており、現在はモデルフィールドおよびネストされた関係を返します；関連 API ドキュメントには `api_method` が含まれる場合もあります。フィールドは後方互換性を保ちながら追加される可能性があるため、クライアントは必要に応じて読み取る必要があります。`children`、解析後のコンテンツ言語、およびコンテンツハッシュが必要な場合は、詳細 API を使用してください。

ソースドキュメントに関連付けられた公開レコードでは、`content_source` がソースドキュメントの識別子、ソースコンテンツハッシュ、リクエストされた言語、翻訳更新時刻、および `ready`、`stale`、`missing`、`missing_source` または `ambiguous` の状態を提供します；その他のレコードでは、このフィールドは `null` です。`ready` 時の `content_hash` はその言語の翻訳文に対応します。本文は、翻訳文が存在しない場合の言語フォールバックを含め、引き続き従来のルールに従って表示されます；ドキュメントを同期する必要があるクライアントは、状態とハッシュの両方を確認する必要があり、本文が空でないことだけで更新済みと判断してはなりません。

## 使用上の推奨事項

* レスポンスには本文が含まれるため、一括同期時はページネーションを使用して適切なタイムアウトを設定し、同じページを並行して取得しないでください。
* alias は公開ページ URL の安定した識別子です；alias が判明している場合は直接 `/api/v1/documents/{alias}` をリクエストしてください。
* 現在の API では親によるサーバー側フィルタリングはできません；ナビゲーションを構築する際は、クライアント側で `parent.id` によりグループ化してください。

## 関連 API

* [AceDataCloud プラットフォームのドキュメント詳細を取得](https://platform.acedata.cloud/documents/platform-document-detail)
* [AceDataCloud プラットフォームの API 詳細を取得](https://platform.acedata.cloud/documents/platform-api-detail)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.