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

# Abrufen der AceDataCloud-Plattform-Dokumentliste

> Platform API guide - Ace Data Cloud

Gibt die für die aktuelle Website sichtbaren Entwicklerdokumente paginiert zurück und kann für Suche, Indizierung oder zum eigenständigen Erstellen einer Navigation im Client verwendet werden. Die Liste enthält derzeit den `content` jeder Dokumentation und verschachtelte übergeordnete Informationen; die Antwort kann groß sein.

## Schnittstellenübersicht

| Element | Inhalt |
| - | - |
| Methode | `GET` |
| URL | `https://platform.acedata.cloud/api/v1/documents/` |
| Authentifizierung | Öffentlich; Nicht-Administratoren können keine privaten Dokumente sehen |
| Paginierung | `count` + `items` |

## Abfrageparameter

| Parameter | Typ | Erforderlich | Standard | Beschreibung |
| - | - | - | - | - |
| `id` | UUID | Nein | — | Nach Dokument-ID filtern; wiederholte Parameter werden unterstützt |
| `private` | boolean | Nein | — | Nach private-Status filtern; Nicht-Administratoren können weiterhin keine privaten Dokumente sehen |
| `type` | string | Nein | — | Exakt nach dem tatsächlichen `type`-Wert von Document filtern |
| `tag` | string | Nein | — | Nach Tag filtern |
| `limit` | integer | Nein | 10 | Anzahl pro Seite, maximal 100 |
| `offset` | integer | Nein | 0 | Paginierungs-Offset |
| `ordering` | string | Nein | `rank` | Unterstützt nur die Sortierung nach `rank`; das Präfix `-` bedeutet absteigende Reihenfolge |

Die aktuelle Listenschnittstelle unterstützt keine Filterung nach `alias` oder `parent_id`. Wenn der Alias bekannt ist, rufen Sie direkt die [Dokumentdetails](https://platform.acedata.cloud/documents/platform-document-detail) auf; beim Erstellen einer Baum-Navigation rufen Sie nach dem Abrufen einer Seite die Daten einmalig ab und gruppieren Sie sie im Client anhand von `parent.id` jedes Elements.

## Anfragebeispiele

```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"))
```

## Antwortstruktur

```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"
    }
  ]
}
```

Die Liste verwendet `DocumentIndexSerializer` und gibt derzeit Modellfelder und verschachtelte Beziehungen zurück; zugehörige API-Dokumente können außerdem `api_method` enthalten. Felder können abwärtskompatibel ergänzt werden; Clients sollten sie nach Bedarf lesen. Wenn `children`, die analysierte Inhaltssprache und der Inhaltshash benötigt werden, verwenden Sie die Detailschnittstelle.

Für öffentliche Datensätze mit verknüpften Quelldokumenten stellt `content_source` die Kennung des Quelldokuments, den Hash des Quellinhalts, die angeforderte Sprache, den Aktualisierungszeitpunkt der Übersetzung sowie den Status `ready`, `stale`, `missing`, `missing_source` oder `ambiguous` bereit; bei anderen Datensätzen ist dieses Feld `null`. Der `content_hash` bei `ready` entspricht der Übersetzung in dieser Sprache. Der Textkörper wird weiterhin nach den ursprünglichen Regeln angezeigt, einschließlich des Sprach-Fallbacks bei fehlender Übersetzung; Clients, die Dokumente synchronisieren müssen, sollten sowohl Status als auch Hash überprüfen und nicht allein anhand eines nicht leeren Textkörpers beurteilen, ob er aktualisiert wurde.

## Verwendungsempfehlungen

* Die Antwort enthält den Textkörper; verwenden Sie bei der Batch-Synchronisierung Paginierung und setzen Sie ein angemessenes Timeout, und rufen Sie nicht dieselbe Seite parallel ab.
* Der Alias ist die stabile Kennung der URL einer öffentlichen Seite; wenn der Alias bekannt ist, fordern Sie direkt `/api/v1/documents/{alias}` an.
* Die aktuelle Schnittstelle kann nicht serverseitig nach übergeordneten Elementen filtern; gruppieren Sie beim Erstellen der Navigation im Client nach `parent.id`.

## Verwandte Schnittstellen

* [Abrufen der AceDataCloud-Plattform-Dokumentdetails](https://platform.acedata.cloud/documents/platform-document-detail)
* [Abrufen der AceDataCloud-Plattform-API-Details](https://platform.acedata.cloud/documents/platform-api-detail)


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