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

# Obtener la lista de documentos de la plataforma AceDataCloud

> Platform API guide - Ace Data Cloud

Devuelve de forma paginada los documentos para desarrolladores visibles en el sitio actual, que pueden utilizarse para búsquedas, indexación o para construir la navegación en el cliente. Actualmente, la lista incluye el `content` y la información del padre anidado de cada documento, por lo que la respuesta puede ser grande.

## Resumen de la interfaz

| Elemento | Contenido |
| - | - |
| Método | `GET` |
| URL | `https://platform.acedata.cloud/api/v1/documents/` |
| Autenticación | Pública; los usuarios no administradores no pueden ver documentos private |
| Paginación | `count` + `items` |

## Parámetros de consulta

| Parámetro | Tipo | Obligatorio | Predeterminado | Descripción |
| - | - | - | - | - |
| `id` | UUID | No | — | Filtra por ID de documento; admite parámetros repetidos |
| `private` | boolean | No | — | Filtra por estado private; los usuarios no administradores aún no pueden ver documentos privados |
| `type` | string | No | — | Filtra de forma exacta por el valor `type` real de Document |
| `tag` | string | No | — | Filtra por etiqueta |
| `limit` | integer | No | 10 | Número de elementos por página, máximo 100 |
| `offset` | integer | No | 0 | Desplazamiento de paginación |
| `ordering` | string | No | `rank` | Solo admite ordenar por `rank`; el prefijo `-` indica orden descendente |

La interfaz de lista actual no admite el filtrado por `alias` o `parent_id`. Cuando se conoce el alias, llame directamente a los [detalles del documento](https://platform.acedata.cloud/documents/platform-document-detail); al construir una navegación en árbol, después de recuperar una página, agrupe en el cliente usando el `parent.id` de cada elemento.

## Ejemplo de solicitud

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

## Estructura de la respuesta

```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 lista utiliza `DocumentIndexSerializer` y actualmente devuelve los campos del modelo y las relaciones anidadas; los documentos de API asociados también pueden incluir `api_method`. Los campos pueden añadirse de forma compatible hacia atrás, y el cliente debe leer según sea necesario. Cuando se necesiten `children`, el idioma del contenido analizado y el hash del contenido, utilice la interfaz de detalles.

Para los registros públicos asociados a documentos fuente, `content_source` proporciona el identificador del documento fuente, el hash del contenido fuente, el idioma solicitado, la hora de actualización de la traducción y los estados `ready`, `stale`, `missing`, `missing_source` o `ambiguous`; para otros registros este campo es `null`. El `content_hash` en estado `ready` corresponde a la traducción en ese idioma. El cuerpo aún se muestra conforme a las reglas originales, incluido el retroceso de idioma cuando falta una traducción; los clientes que necesiten sincronizar documentos deben comprobar tanto el estado como el hash, y no pueden determinar que se ha actualizado únicamente porque el cuerpo no esté vacío.

## Recomendaciones de uso

* La respuesta contiene el cuerpo; al sincronizar en lote, utilice paginación y establezca un tiempo de espera razonable, no recupere la misma página de forma simultánea.
* El alias es el identificador estable de la URL de la página pública; cuando se conoce el alias, solicite directamente `/api/v1/documents/{alias}`.
* La interfaz actual no puede filtrar en el servidor por padre; al construir la navegación, agrupe en el cliente por `parent.id`.

## Interfaces relacionadas

* [Obtener los detalles del documento de la plataforma AceDataCloud](https://platform.acedata.cloud/documents/platform-document-detail)
* [Obtener los detalles de la API de la plataforma AceDataCloud](https://platform.acedata.cloud/documents/platform-api-detail)


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