> ## 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 APIs da plataforma AceDataCloud

> Platform API guide - Ace Data Cloud

Retorna de forma paginada os endpoints de API visíveis no site atual. Adequado para localizar APIs por caminho de negócio, serviço ou estágio de publicação; se você precisar apenas da definição completa de uma API, chame diretamente os [detalhes da API](https://platform.acedata.cloud/documents/platform-api-detail).

## Visão geral da interface

| Item | Conteúdo |
| - | - |
| Método | `GET` |
| URL | `https://platform.acedata.cloud/api/v1/apis/` |
| Autenticação | Pública, não requer token de conta |
| Paginação | `count` + `items` |

## Parâmetros de consulta

| Parâmetro | Tipo | Obrigatório | Descrição |
| - | - | - | - |
| `path` | string | Não | Correspondência exata com `path` ou `path2` |
| `service` | string | Não | Alias ou UUID do serviço |
| `stage` | string | Não | Filtra por estágio de publicação; vários valores podem ser enviados repetidamente |
| `limit` | integer | Não | Número de itens por página, máximo de 100 |
| `offset` | integer | Não | Deslocamento da paginação |

`id`, `service_id` e `tag` atualmente não são parâmetros de filtro da lista; enviá-los não produzirá o efeito de filtragem correspondente.

```shell theme={null}
curl --get 'https://platform.acedata.cloud/api/v1/apis/' \
  --data-urlencode 'service=midjourney' \
  --data-urlencode 'stage=Production' \
  --data-urlencode 'limit=20' \
  -H 'Accept: application/json'
```

```python theme={null}
import requests

response = requests.get(
    "https://platform.acedata.cloud/api/v1/apis/",
    params={"service": "midjourney", "limit": 20},
    timeout=30,
)
response.raise_for_status()
for api in response.json()["items"]:
    print(api["id"], api["method"], api["path"])
```

## Descrição da resposta

A resposta online usa `{count, items}`. Cada item da lista atualmente contém os campos do modelo de API, além de:

* `document_id`: ID do documento do desenvolvedor associado, podendo estar vazio;
* `service_id` / `service`: ID e resumo do serviço principal, podendo estar vazios;
* `definition`: definição OpenAPI, que pode ser grande;
* `method`, `path`, `path2`, `stage`, `cost`, `tags`, `metadata` e outros.

O serializer da lista atualmente inclui `definition`; ao buscar o catálogo completo, deve-se paginar e definir um tempo limite. Os campos podem ser adicionados de forma compatível com versões anteriores, e o cliente deve ler apenas os campos necessários.

## Próximos passos

* [Obter detalhes da API](https://platform.acedata.cloud/documents/platform-api-detail)
* [Obter a lista de serviços](https://platform.acedata.cloud/documents/platform-service-list)
* [Obter APIs de um serviço](https://platform.acedata.cloud/documents/platform-service-apis)


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