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

> Platform API guide - Ace Data Cloud

Obtenha informações completas de um único endpoint de API por meio do ID da API — em comparação com a [interface de lista](https://platform.acedata.cloud/documents/platform-api-list), inclui os campos adicionais `definition` (Schema OpenAPI 3.0), `service` (detalhes do serviço ao qual pertence) e `products` (produtos associados).

Adequado para cenários como geração automática de SDK, fornecer descrições de ferramentas para LLM Agent, renderização dinâmica de sites de documentação, entre outros.

> ℹ️ Esta interface pertence à **API de gerenciamento da plataforma AceDataCloud**, com o prefixo unificado `https://platform.acedata.cloud/api/v1/`. Para o índice completo de interfaces, consulte [Obter lista de documentos da plataforma AceDataCloud](https://platform.acedata.cloud/documents/platform-document-list).

## Visão geral da interface

| Item | Conteúdo |
| - | - |
| Método | `GET` |
| URL | `https://platform.acedata.cloud/api/v1/apis/{api_id}` |
| Autenticação | ❌ Pública |

`/apis/{id}` e `/apis/{id}/` estão disponíveis atualmente; os exemplos usam uniformemente o formato sem barra final.

## Instruções de autenticação

Esta interface é **completamente pública, sem necessidade de token de conta ou estado de login**.

## Parâmetros de caminho

| Parâmetro | Tipo | Obrigatório | Descrição |
| - | - | - | - |
| `api_id` | UUID | ✅ | ID da API (formato UUID, não oferece suporte a alias) |

## Exemplos de solicitação

### cURL

```shell theme={null}
curl 'https://platform.acedata.cloud/api/v1/apis/afc7917f-d89f-4dc9-95c2-863936b02cad' \
  -H 'accept: application/json'
```

### Python

```python theme={null}
import requests

api_id = "afc7917f-d89f-4dc9-95c2-863936b02cad"
resp = requests.get(
    f"https://platform.acedata.cloud/api/v1/apis/{api_id}",
    headers={"accept": "application/json"},
    timeout=10,
)
api = resp.json()
print(f"API: {api['title']}")
print(f"Caminho: {api['path']}")
print(f"Serviço ao qual pertence: {api['service']['title']} ({api['service']['alias']})")
print(f"Número de caminhos OpenAPI: {len(api.get('definition', {}).get('paths', {}))}")
```

### Node.js

```javascript theme={null}
const apiId = 'afc7917f-d89f-4dc9-95c2-863936b02cad'
const r = await fetch(`https://platform.acedata.cloud/api/v1/apis/${apiId}`)
const api = await r.json()
console.log(api.title, api.path, api.service.title)
```

## Exemplo de resposta (HTTP 200)

```json theme={null}
{
  "id": "afc7917f-d89f-4dc9-95c2-863936b02cad",
  "document_id": "e31b3e50-d91d-4a4f-8d32-8dd8c9e2f512",
  "service_id": "5d732942-4d44-48be-958e-dd8474d8aa8d",
  "name": "ChatDoc Documents API",
  "title": "ChatDoc Documents API",
  "path": "/chatdoc/documents",
  "path2": null,
  "introduction": "Após criar o repositório de conhecimento, esta API pode ser usada para adicionar, consultar, modificar ou excluir documentos no repositório de conhecimento.",
  "cost": [
    { "conditions": { "==": [1, 1] }, "consumption": 0.057 }
  ],
  "stage": "Beta",
  "rank": 10,
  "tags": [],
  "metadata": null,
  "created_at": "2023-09-03T17:55:48.179195Z",
  "updated_at": "2026-04-26T16:16:35.579082Z",
  "service": {
    "id": "5d732942-4d44-48be-958e-dd8474d8aa8d",
    "title": "ChatDoc Perguntas e respostas",
    "type": "Api",
    "alias": "chatdoc"
  },
  "products": [],
  "definition": {
    "openapi": "3.0.0",
    "info": { "title": "ChatDoc Documents API", "version": "0.1" },
    "paths": {
      "/chatdoc/documents": {
        "post": { "...": "..." }
      }
    },
    "components": { "schemas": { "...": "..." } }
  }
}
```

## Descrição dos campos de resposta

A interface de detalhes inclui adicionalmente, além dos [campos da interface de lista](https://platform.acedata.cloud/documents/platform-api-list):

| Campo | Tipo | Descrição |
| - | - | - |
| `service` | object | Informações essenciais do serviço ao qual pertence: `id`, `title`, `type`, `alias` |
| `products` | array | Lista de produtos associados (normalmente vazia, usada pelo lado operacional) |
| `definition` | object | **Definição completa da especificação OpenAPI 3.0**, incluindo `paths`, `components`, `info` etc., podendo ser fornecida diretamente ao `openapi-generator` para gerar código de cliente |

## Tratamento de erros

| HTTP | code | Significado |
| - | - | - |
| 400 | `invalid` | `api_id` não é um UUID válido |
| 404 | `not_found` | A API não existe ou foi desativada |

## Dicas práticas

* **O campo `definition` é muito grande**: o Schema OpenAPI de uma única API pode ter centenas de linhas de JSON. Se for apenas para criar um índice de serviços e não precisar do Schema, deve-se usar a [interface de lista](https://platform.acedata.cloud/documents/platform-api-list) em vez disso.
* **Uso comum para gerar SDK**:
  ```shell theme={null}
  # Obter o arquivo OpenAPI
  curl -s 'https://platform.acedata.cloud/api/v1/apis/<api_id>' | jq '.definition' > openapi.json

  # Gerar o cliente Python com openapi-generator-cli
  openapi-generator-cli generate -i openapi.json -g python -o ./client
  ```
* **Rastrear alterações da API**: o campo `updated_at` é o horário da última alteração no schema. Assinar este campo permite gerar novamente o SDK automaticamente quando houver alterações no OpenAPI.

## Interfaces relacionadas

* [Obter lista de APIs da plataforma AceDataCloud](https://platform.acedata.cloud/documents/platform-api-list)
* [Obter estatísticas de chamadas de API da plataforma AceDataCloud](https://platform.acedata.cloud/documents/platform-api-usage)
* [Obter detalhes do serviço da plataforma AceDataCloud](https://platform.acedata.cloud/documents/platform-service-detail)
* [Obter detalhes do documento da plataforma AceDataCloud](https://platform.acedata.cloud/documents/platform-document-detail) — use `document_id` para acessar a documentação do desenvolvedor com renderização


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