> ## 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 | Нет | — | Точная фильтрация по фактическому значению `type` Document |
| `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`. `content_hash` при `ready` соответствует переводу на этом языке. Основной текст по-прежнему отображается согласно исходным правилам, включая языковой откат при отсутствии перевода; клиентам, которым требуется синхронизация документов, следует одновременно проверять статус и хеш, а не судить об обновлении только по непустому основному тексту.

## Рекомендации по использованию

* Ответ содержит основной текст; при пакетной синхронизации используйте пагинацию и задавайте разумный тайм-аут, не загружайте одну и ту же страницу параллельно.
* alias — стабильный идентификатор URL публичной страницы; при известном alias напрямую запрашивайте `/api/v1/documents/{alias}`.
* Текущий интерфейс не позволяет выполнять серверную фильтрацию по родительскому элементу; при построении навигации группируйте на клиенте по `parent.id`.

## Связанные интерфейсы

* [Получение деталей документа платформы AceDataCloud](https://platform.acedata.cloud/documents/platform-document-detail)
* [Получение деталей API платформы AceDataCloud](https://platform.acedata.cloud/documents/platform-api-detail)


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