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

# Abrufen von AceDataCloud-Plattform-API-Details

> Platform API guide - Ace Data Cloud

Rufen Sie vollständige Informationen zu einem einzelnen API-Endpunkt über die API-ID ab — im Vergleich zur [Listen-Schnittstelle](https://platform.acedata.cloud/documents/platform-api-list) zusätzlich mit den Feldern `definition` (OpenAPI-3.0-Schema), `service` (Details zum zugehörigen Dienst) und `products` (verknüpfte Produkte).

Geeignet für Szenarien wie die automatische SDK-Generierung, das Bereitstellen von Werkzeugbeschreibungen für LLM-Agenten und das dynamische Rendern von Dokumentationswebsites.

> ℹ️ Diese Schnittstelle gehört zur **AceDataCloud-Plattformverwaltungs-API** mit dem einheitlichen Präfix `https://platform.acedata.cloud/api/v1/`. Den vollständigen Schnittstellenindex finden Sie unter [Abrufen der AceDataCloud-Plattform-Dokumentationsliste](https://platform.acedata.cloud/documents/platform-document-list).

## Schnittstellenübersicht

| Element | Inhalt |
| - | - |
| Methode | `GET` |
| URL | `https://platform.acedata.cloud/api/v1/apis/{api_id}` |
| Authentifizierung | ❌ Öffentlich |

`/apis/{id}` und `/apis/{id}/` sind derzeit beide verfügbar; die Beispiele verwenden einheitlich die Form ohne abschließenden Schrägstrich.

## Hinweise zur Authentifizierung

Diese Schnittstelle ist **vollständig öffentlich und erfordert weder ein Kontotoken noch einen Anmeldestatus**.

## Pfadparameter

| Parameter | Typ | Erforderlich | Beschreibung |
| - | - | - | - |
| `api_id` | UUID | ✅ | API-ID (UUID-Format, keine Aliase unterstützt) |

## Anfragebeispiele

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

## Antwortbeispiel (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": { "...": "..." } }
  }
}
```

## Beschreibung der Antwortfelder

Die Detail-Schnittstelle enthält zusätzlich zu den [Feldern der Listen-Schnittstelle](https://platform.acedata.cloud/documents/platform-api-list):

| Feld | Typ | Beschreibung |
| - | - | - |
| `service` | object | Kerninformationen des zugehörigen Dienstes: `id`, `title`, `type`, `alias` |
| `products` | array | Liste verknüpfter Produkte (normalerweise leer, zur Verwendung durch die Betriebsseite) |
| `definition` | object | **Vollständige OpenAPI-3.0-Spezifikationsdefinition**, enthält `paths`, `components`, `info` usw. und kann direkt an `openapi-generator` zur Generierung von Clientcode übergeben werden |

## Fehlerbehandlung

| HTTP | code | Bedeutung |
| - | - | - |
| 400 | `invalid` | `api_id` ist keine gültige UUID |
| 404 | `not_found` | API existiert nicht oder wurde eingestellt |

## Praktische Hinweise

* **Das Feld `definition` ist sehr groß**: Das OpenAPI-Schema einer einzelnen API kann mehrere hundert Zeilen JSON umfassen. Wenn Sie nur einen Dienstindex benötigen und kein Schema brauchen, sollten Sie stattdessen die [Listen-Schnittstelle](https://platform.acedata.cloud/documents/platform-api-list) verwenden.
* **Häufige Verwendung zur SDK-Generierung**:
  ```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
  ```
* **API-Änderungen verfolgen**: Das Feld `updated_at` ist der Zeitpunkt der letzten Schemaänderung. Durch Abonnieren dieses Feldes kann das SDK bei OpenAPI-Änderungen automatisch neu generiert werden.

## Verwandte Schnittstellen

* [Abrufen der AceDataCloud-Plattform-API-Liste](https://platform.acedata.cloud/documents/platform-api-list)
* [Abrufen der Aufrufstatistiken der AceDataCloud-Plattform-API](https://platform.acedata.cloud/documents/platform-api-usage)
* [Abrufen der AceDataCloud-Plattform-Dienstedetails](https://platform.acedata.cloud/documents/platform-service-detail)
* [Abrufen der AceDataCloud-Plattform-Dokumentdetails](https://platform.acedata.cloud/documents/platform-document-detail) — Verwenden Sie `document_id`, um zur gerenderten Entwicklerdokumentation zu wechseln


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