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

# Obter a Lista de Documentos da Plataforma AceDataCloud

> Platform API guide - Ace Data Cloud

Retorna de forma paginada os documentos de desenvolvedor visíveis no site atual, que podem ser usados para pesquisa, indexação ou para construir navegação no cliente. A lista atualmente contém o `content` e informações de pai aninhadas para cada documento, e a resposta pode ser grande.

## Visão Geral da Interface

| Item | Conteúdo |
| - | - |
| Método | `GET` |
| URL | `https://platform.acedata.cloud/api/v1/documents/` |
| Autenticação | Público; não administradores não podem ver documentos private |
| Paginação | `count` + `items` |

## Parâmetros de Consulta

| Parâmetro | Tipo | Obrigatório | Padrão | Descrição |
| - | - | - | - | - |
| `id` | UUID | Não | — | Filtra por ID do documento; suporta parâmetros repetidos |
| `private` | boolean | Não | — | Filtra pelo estado private; não administradores ainda não podem ver documentos privados |
| `type` | string | Não | — | Filtra precisamente pelo valor real de `type` do Document |
| `tag` | string | Não | — | Filtra por tag |
| `limit` | integer | Não | 10 | Número de itens por página, máximo de 100 |
| `offset` | integer | Não | 0 | Deslocamento de paginação |
| `ordering` | string | Não | `rank` | Suporta apenas ordenação por `rank`; o prefixo `-` indica ordem decrescente |

A interface de lista atual não suporta filtragem por `alias` ou `parent_id`. Quando o alias for conhecido, chame diretamente os [detalhes do documento](https://platform.acedata.cloud/documents/platform-document-detail); ao construir navegação em árvore, após buscar uma página de cada vez, use o `parent.id` de cada item para agrupar no cliente.

## Exemplo de Solicitação

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

## Estrutura da Resposta

```json theme={null}
{
  "count": 1,
  "items": [
    {
      "id": "00000000-0000-4000-8000-000000000001",
      "alias": "platform-token",
      "name": "Document of Platform Token",
      "title": "Gerenciar Tokens de Conta (Account Token) da Plataforma AceDataCloud",
      "content": "# Gerenciar Tokens de Conta da Plataforma AceDataCloud……",
      "type": "Text",
      "private": false,
      "primary_only": false,
      "rank": 2400,
      "tags": [
        "development"
      ],
      "parent": {
        "id": "00000000-0000-4000-8000-000000000002",
        "alias": "platform",
        "title": "Plataforma 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"
    }
  ]
}
```

A lista usa `DocumentIndexSerializer` e atualmente retorna campos do modelo e relações aninhadas; documentos de API associados também podem incluir `api_method`. Campos podem ser adicionados de forma retrocompatível, e o cliente deve ler conforme necessário. Quando forem necessários `children`, o idioma de conteúdo analisado e o hash de conteúdo, use a interface de detalhes.

Para registros públicos associados a documentos de origem, `content_source` fornece o identificador do documento de origem, o hash do conteúdo de origem, o idioma solicitado, a hora de atualização da tradução e o status `ready`, `stale`, `missing`, `missing_source` ou `ambiguous`; para outros registros, esse campo é `null`. O `content_hash` quando `ready` corresponde à tradução nesse idioma. O corpo ainda é exibido segundo as regras originais, incluindo o fallback de idioma quando falta uma tradução; clientes que precisam sincronizar documentos devem verificar simultaneamente o status e o hash, e não podem determinar que foi atualizado apenas porque o corpo não está vazio.

## Recomendações de Uso

* A resposta contém o corpo do texto; ao sincronizar em lote, use paginação e defina um tempo limite razoável, não busque a mesma página simultaneamente.
* alias é o identificador estável da URL da página pública; quando o alias for conhecido, solicite diretamente `/api/v1/documents/{alias}`.
* A interface atual não pode filtrar por pai no servidor; ao construir a navegação, agrupe no cliente por `parent.id`.

## Interfaces Relacionadas

* [Obter Detalhes do Documento da Plataforma AceDataCloud](https://platform.acedata.cloud/documents/platform-document-detail)
* [Obter Detalhes da API da 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.