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

# Obtenir la liste des documents de la plateforme AceDataCloud

> Platform API guide - Ace Data Cloud

Renvoie de manière paginée les documents développeur visibles du site actuel, utilisables pour la recherche, l’indexation ou la construction autonome de la navigation côté client. La liste contient actuellement le `content` et les informations parent imbriquées de chaque document, la réponse peut être volumineuse.

## Aperçu de l’interface

| Élément | Contenu |
| - | - |
| Méthode | `GET` |
| URL | `https://platform.acedata.cloud/api/v1/documents/` |
| Authentification | Publique ; les non-administrateurs ne peuvent pas voir les documents private |
| Pagination | `count` + `items` |

## Paramètres de requête

| Paramètre | Type | Obligatoire | Par défaut | Description |
| - | - | - | - | - |
| `id` | UUID | Non | — | Filtrer par ID de document ; prend en charge les paramètres répétés |
| `private` | boolean | Non | — | Filtrer par état private ; les non-administrateurs ne peuvent toujours pas voir les documents privés |
| `type` | string | Non | — | Filtrer exactement selon la valeur réelle de `type` du Document |
| `tag` | string | Non | — | Filtrer par étiquette |
| `limit` | integer | Non | 10 | Nombre d’éléments par page, maximum 100 |
| `offset` | integer | Non | 0 | Décalage de pagination |
| `ordering` | string | Non | `rank` | Prend uniquement en charge le tri par `rank` ; le préfixe `-` indique l’ordre décroissant |

L’interface de liste actuelle ne prend pas en charge le filtrage par `alias` ou `parent_id`. Lorsque l’alias est connu, appelez directement les [détails du document](https://platform.acedata.cloud/documents/platform-document-detail) ; lors de la construction d’une navigation arborescente, récupérez les pages une fois puis regroupez côté client en utilisant `parent.id` de chaque élément.

## Exemple de requête

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

## Structure de la réponse

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

La liste utilise `DocumentIndexSerializer` et renvoie actuellement les champs du modèle ainsi que les relations imbriquées ; les documents API associés peuvent également contenir `api_method`. Des champs peuvent être ajoutés de manière rétrocompatible, le client doit les lire selon ses besoins. Lorsque `children`, la langue de contenu analysée et le hachage du contenu sont nécessaires, utilisez l’interface de détails.

Pour les enregistrements publics associés à des documents sources, `content_source` fournit l’identifiant du document source, le hachage du contenu source, la langue demandée, l’heure de mise à jour de la traduction et les états `ready`, `stale`, `missing`, `missing_source` ou `ambiguous` ; pour les autres enregistrements, ce champ est `null`. Le `content_hash` lorsque l’état est `ready` correspond à la traduction dans cette langue. Le corps du texte est toujours affiché selon les règles existantes, y compris le repli de langue en cas de traduction manquante ; les clients devant synchroniser les documents doivent vérifier simultanément l’état et le hachage, et ne peuvent pas déterminer qu’une mise à jour est effectuée uniquement parce que le corps du texte n’est pas vide.

## Recommandations d’utilisation

* La réponse contient le corps du texte ; lors de synchronisations par lots, utilisez la pagination et définissez un délai d’attente raisonnable, ne récupérez pas la même page simultanément.
* L’alias est l’identifiant stable de l’URL de la page publique ; lorsque l’alias est connu, demandez directement `/api/v1/documents/{alias}`.
* L’interface actuelle ne peut pas filtrer côté serveur par parent ; lors de la construction de la navigation, regroupez côté client par `parent.id`.

## Interfaces associées

* [Obtenir les détails du document de la plateforme AceDataCloud](https://platform.acedata.cloud/documents/platform-document-detail)
* [Obtenir les détails de l’API de la plateforme AceDataCloud](https://platform.acedata.cloud/documents/platform-api-detail)


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