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

# Pobieranie szczegółów API platformy AceDataCloud

> Platform API guide - Ace Data Cloud

Pobierz pełne informacje o pojedynczym punkcie końcowym API za pomocą API ID — w porównaniu z [interfejsem listy](https://platform.acedata.cloud/documents/platform-api-list) zawiera dodatkowe pola `definition` (OpenAPI 3.0 Schema), `service` (szczegóły należącej usługi) i `products` (powiązane produkty).

Nadaje się do automatycznego generowania SDK, przekazywania opisów narzędzi do LLM Agent, dynamicznego renderowania stron dokumentacji i innych scenariuszy.

> ℹ️ Ten interfejs należy do **API zarządzania platformą AceDataCloud**, ze wspólnym prefiksem `https://platform.acedata.cloud/api/v1/`. Pełny indeks interfejsów znajdziesz w [Pobieranie listy dokumentów platformy AceDataCloud](https://platform.acedata.cloud/documents/platform-document-list).

## Przegląd interfejsu

| Pozycja | Treść |
| - | - |
| Metoda | `GET` |
| URL | `https://platform.acedata.cloud/api/v1/apis/{api_id}` |
| Uwierzytelnianie | ❌ Publiczne |

`/apis/{id}` i `/apis/{id}/` są obecnie oba dostępne; przykłady konsekwentnie używają formy bez końcowego ukośnika.

## Informacje o uwierzytelnianiu

Ten interfejs jest **całkowicie publiczny i nie wymaga tokena konta ani stanu logowania**.

## Parametry ścieżki

| Parametr | Typ | Wymagany | Opis |
| - | - | - | - |
| `api_id` | UUID | ✅ | API ID (format UUID, aliasy nie są obsługiwane) |

## Przykłady żądań

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

## Przykład odpowiedzi (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": { "...": "..." } }
  }
}
```

## Opis pól odpowiedzi

Interfejs szczegółów zawiera dodatkowo, oprócz [pól interfejsu listy](https://platform.acedata.cloud/documents/platform-api-list):

| Pole | Typ | Opis |
| - | - | - |
| `service` | object | Kluczowe informacje należącej usługi: `id`, `title`, `type`, `alias` |
| `products` | array | Lista powiązanych produktów (zwykle pusta, do użytku po stronie operacyjnej) |
| `definition` | object | **Pełna definicja specyfikacji OpenAPI 3.0**, zawiera `paths`, `components`, `info` itd.; można ją bezpośrednio przekazać do `openapi-generator` w celu wygenerowania kodu klienta |

## Obsługa błędów

| HTTP | code | Znaczenie |
| - | - | - |
| 400 | `invalid` | `api_id` nie jest prawidłowym UUID |
| 404 | `not_found` | API nie istnieje lub zostało wycofane |

## Praktyczne wskazówki

* **Pole `definition` jest bardzo duże**: OpenAPI Schema pojedynczego API może mieć setki wierszy JSON. Jeśli potrzebujesz tylko indeksu usług i nie potrzebujesz Schema, użyj zamiast tego [interfejsu listy](https://platform.acedata.cloud/documents/platform-api-list).
* **Typowe zastosowanie do generowania 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
  ```
* **Śledzenie zmian API**: pole `updated_at` to czas ostatniej zmiany schema. Subskrybowanie tego pola umożliwia automatyczne ponowne generowanie SDK po zmianach OpenAPI.

## Powiązane interfejsy

* [Pobieranie listy API platformy AceDataCloud](https://platform.acedata.cloud/documents/platform-api-list)
* [Pobieranie statystyk wywołań API platformy AceDataCloud](https://platform.acedata.cloud/documents/platform-api-usage)
* [Pobieranie szczegółów usługi platformy AceDataCloud](https://platform.acedata.cloud/documents/platform-service-detail)
* [Pobieranie szczegółów dokumentu platformy AceDataCloud](https://platform.acedata.cloud/documents/platform-document-detail) — użyj `document_id`, aby przejść do wyrenderowanej dokumentacji dla programistów


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