> ## 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 los detalles de la API de la plataforma AceDataCloud

> Platform API guide - Ace Data Cloud

Obtiene la información completa de un único endpoint de API mediante el ID de API; en comparación con la [interfaz de lista](https://platform.acedata.cloud/documents/platform-api-list), incluye los campos adicionales `definition` (OpenAPI 3.0 Schema), `service` (detalles del servicio al que pertenece) y `products` (productos asociados).

Adecuado para escenarios como la generación automática de SDK, alimentar a un LLM Agent con descripciones de herramientas, la renderización dinámica de sitios de documentación, etc.

> ℹ️ Esta interfaz pertenece a la **API de administración de la plataforma AceDataCloud**, con el prefijo unificado `https://platform.acedata.cloud/api/v1/`. Para el índice completo de interfaces, consulta [Obtener la lista de documentos de la plataforma AceDataCloud](https://platform.acedata.cloud/documents/platform-document-list).

## Resumen de la interfaz

| Elemento | Contenido |
| - | - |
| Método | `GET` |
| URL | `https://platform.acedata.cloud/api/v1/apis/{api_id}` |
| Autenticación | ❌ Pública |

Actualmente, tanto `/apis/{id}` como `/apis/{id}/` están disponibles; los ejemplos utilizan de forma unificada la variante sin barra final.

## Descripción de autenticación

Esta interfaz es **completamente pública y no requiere token de cuenta ni sesión iniciada**.

## Parámetros de ruta

| Parámetro | Tipo | Obligatorio | Descripción |
| - | - | - | - |
| `api_id` | UUID | ✅ | ID de API (formato UUID; no se admiten alias) |

## Ejemplos de solicitud

### 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"路径: {api['path']}")
print(f"所属服务: {api['service']['title']} ({api['service']['alias']})")
print(f"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)
```

## Ejemplo de respuesta (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": "在创建知识存储库之后，可以使用该API在知识存储库中添加、查询、修改或删除文档。",
  "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 问答",
    "type": "Api",
    "alias": "chatdoc"
  },
  "products": [],
  "definition": {
    "openapi": "3.0.0",
    "info": { "title": "ChatDoc Documents API", "version": "0.1" },
    "paths": {
      "/chatdoc/documents": {
        "post": { "...": "..." }
      }
    },
    "components": { "schemas": { "...": "..." } }
  }
}
```

## Descripción de los campos de respuesta

La interfaz de detalles incluye adicionalmente, sobre los [campos de la interfaz de lista](https://platform.acedata.cloud/documents/platform-api-list):

| Campo | Tipo | Descripción |
| - | - | - |
| `service` | object | Información principal del servicio al que pertenece: `id`, `title`, `type`, `alias` |
| `products` | array | Lista de productos asociados (generalmente vacía; para uso del equipo de operaciones) |
| `definition` | object | **Definición completa de la especificación OpenAPI 3.0**, incluye `paths`, `components`, `info`, etc., y puede proporcionarse directamente a `openapi-generator` para generar código cliente |

## Gestión de errores

| HTTP | code | Significado |
| - | - | - |
| 400 | `invalid` | `api_id` no es un UUID válido |
| 404 | `not_found` | La API no existe o ha sido desactivada |

## Consejos prácticos

* **El campo `definition` es muy grande**: el OpenAPI Schema de una sola API puede contener cientos de líneas de JSON. Si solo se necesita crear un índice de servicios y no se requiere el Schema, se debe utilizar la [interfaz de lista](https://platform.acedata.cloud/documents/platform-api-list) en su lugar.
* **Uso habitual para generar SDK**:
  ```shell theme={null}
  # 拿到 OpenAPI 文件
  curl -s 'https://platform.acedata.cloud/api/v1/apis/<api_id>' | jq '.definition' > openapi.json

  # 用 openapi-generator-cli 生成 Python 客户端
  openapi-generator-cli generate -i openapi.json -g python -o ./client
  ```
* **Seguimiento de cambios de API**: el campo `updated_at` es la hora de la última modificación del schema. Suscribirse a este campo permite regenerar automáticamente el SDK cuando OpenAPI cambie.

## Interfaces relacionadas

* [Obtener la lista de API de la plataforma AceDataCloud](https://platform.acedata.cloud/documents/platform-api-list)
* [Obtener las estadísticas de llamadas de API de la plataforma AceDataCloud](https://platform.acedata.cloud/documents/platform-api-usage)
* [Obtener los detalles del servicio de la plataforma AceDataCloud](https://platform.acedata.cloud/documents/platform-service-detail)
* [Obtener los detalles del documento de la plataforma AceDataCloud](https://platform.acedata.cloud/documents/platform-document-detail) — usa `document_id` para ir a la documentación para desarrolladores renderizada


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