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

# Hämta AceDataCloud-plattformens dokumentlista

> Platform API guide - Ace Data Cloud

Returnerar synliga utvecklardokument för den aktuella webbplatsen sida för sida, vilket kan användas för sökning, indexering eller för att själv bygga navigering i klienten. Listan innehåller för närvarande varje dokuments `content` och kapslad överordnad information, och svaret kan vara stort.

## API-översikt

| Post | Innehåll |
| - | - |
| Metod | `GET` |
| URL | `https://platform.acedata.cloud/api/v1/documents/` |
| Autentisering | Offentlig; icke-administratörer kan inte se private-dokument |
| Sidindelning | `count` + `items` |

## Frågeparametrar

| Parameter | Typ | Obligatorisk | Standard | Beskrivning |
| - | - | - | - | - |
| `id` | UUID | Nej | — | Filtrera efter dokument-ID; stöder upprepade parametrar |
| `private` | boolean | Nej | — | Filtrera efter private-status; icke-administratörer kan fortfarande inte se privata dokument |
| `type` | string | Nej | — | Exakt filtrering efter Documents faktiska `type`-värde |
| `tag` | string | Nej | — | Filtrera efter tagg |
| `limit` | integer | Nej | 10 | Antal per sida, högst 100 |
| `offset` | integer | Nej | 0 | Sidindelningsförskjutning |
| `ordering` | string | Nej | `rank` | Stöder endast sortering efter `rank`; prefixet `-` anger fallande ordning |

Det aktuella list-API:t stöder inte filtrering på `alias` eller `parent_id`. Vid känt alias, anropa direkt [dokumentdetaljer](https://platform.acedata.cloud/documents/platform-document-detail); vid konstruktion av trädnavigation, hämta en sida i taget och gruppera sedan efter varje posts `parent.id` i klienten.

## Exempel på begäran

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

## Svarsstruktur

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

Listan använder `DocumentIndexSerializer` och returnerar för närvarande modellfält och kapslade relationer; relaterade API-dokument kan även innehålla `api_method`. Fält kan läggas till på ett bakåtkompatibelt sätt, och klienten bör läsa dem vid behov. När `children`, det parsade innehållsspråket och innehållshashen behövs, använd detalj-API:t.

För offentliga poster som är associerade med källdokument tillhandahåller `content_source` källdokumentets identifierare, källinnehållshash, det begärda språket, uppdateringstid för översättning samt statusen `ready`, `stale`, `missing`, `missing_source` eller `ambiguous`; för andra poster är fältet `null`. `content_hash` vid `ready` motsvarar översättningen för det språket. Brödtexten visas fortfarande enligt de ursprungliga reglerna, inklusive språkåterställning när översättning saknas; klienter som behöver synkronisera dokument bör kontrollera både status och hash och kan inte enbart avgöra om uppdateringen har skett utifrån att brödtexten inte är tom.

## Användningsrekommendationer

* Svaret innehåller brödtext; använd sidindelning och ange rimlig timeout vid batchsynkronisering, och hämta inte samma sida parallellt.
* alias är den stabila identifieraren för den offentliga sidans URL; vid känt alias, begär direkt `/api/v1/documents/{alias}`.
* Det aktuella API:t kan inte filtrera efter överordnad på serversidan; gruppera efter `parent.id` i klienten när navigering byggs.

## Relaterade API:er

* [Hämta AceDataCloud-plattformens dokumentdetaljer](https://platform.acedata.cloud/documents/platform-document-detail)
* [Hämta AceDataCloud-plattformens API-detaljer](https://platform.acedata.cloud/documents/platform-api-detail)


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