> ## 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` 및 중첩된 상위 정보가 포함되어 있으며, 응답이 클 수 있습니다.

## 인터페이스 개요

| 항목 | 내용 |
| - | - |
| 메서드 | `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 | 페이지당 항목 수, 최대 100 |
| `offset` | integer | 아니요 | 0 | 페이지네이션 오프셋 |
| `ordering` | string | 아니요 | `rank` | `rank` 기준 정렬만 지원; 접두사 `-`는 내림차순을 의미 |

현재 목록 인터페이스는 `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`, 파싱된 콘텐츠 언어 및 콘텐츠 해시가 필요한 경우 상세 인터페이스를 사용하십시오.

소스 문서에 연결된 공개 레코드의 경우, `content_source`는 소스 문서 식별자, 소스 콘텐츠 해시, 요청된 언어, 번역 업데이트 시간 및 `ready`, `stale`, `missing`, `missing_source` 또는 `ambiguous` 상태를 제공합니다; 다른 레코드에서는 이 필드가 `null`입니다. `ready`일 때의 `content_hash`는 해당 언어 번역문에 대응합니다. 본문은 번역문이 없을 때의 언어 폴백을 포함하여 기존 규칙에 따라 계속 표시됩니다; 문서를 동기화해야 하는 클라이언트는 상태와 해시를 동시에 확인해야 하며, 본문이 비어 있지 않은지만으로 업데이트되었는지 판단할 수 없습니다.

## 사용 권장 사항

* 응답에는 본문이 포함되므로, 일괄 동기화 시 페이지네이션을 사용하고 적절한 타임아웃을 설정하며, 같은 페이지를 동시에 가져오지 마십시오.
* alias는 공개 페이지 URL의 안정적인 식별자입니다; alias를 알고 있는 경우 `/api/v1/documents/{alias}`를 직접 요청하십시오.
* 현재 인터페이스는 상위 항목 기준 서버 측 필터링을 할 수 없습니다; 탐색을 구축할 때 클라이언트에서 `parent.id` 기준으로 그룹화하십시오.

## 관련 인터페이스

* [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.