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

# Отримання деталей API платформи AceDataCloud

> Platform API guide - Ace Data Cloud

Отримайте повну інформацію про одну кінцеву точку API за ID API — на відміну від [інтерфейсу списку](https://platform.acedata.cloud/documents/platform-api-list), додаються поля `definition` (OpenAPI 3.0 Schema), `service` (деталі належної служби) та `products` (пов’язані продукти).

Підходить для таких сценаріїв, як автоматичне генерування SDK, передавання описів інструментів LLM Agent, динамічний рендеринг сайтів документації тощо.

> ℹ️ Цей інтерфейс належить до **API керування платформою AceDataCloud**, з єдиним префіксом `https://platform.acedata.cloud/api/v1/`. Повний індекс інтерфейсів дивіться в [Отримання списку документів платформи AceDataCloud](https://platform.acedata.cloud/documents/platform-document-list).

## Огляд інтерфейсу

| Пункт | Вміст |
| - | - |
| Метод | `GET` |
| URL | `https://platform.acedata.cloud/api/v1/apis/{api_id}` |
| Автентифікація | ❌ Відкрита |

Наразі доступні як `/apis/{id}`, так і `/apis/{id}/`; у прикладах уніфіковано використовується форма без завершального слеша.

## Опис автентифікації

Цей інтерфейс **повністю відкритий, не потребує токена облікового запису або стану входу**.

## Параметри шляху

| Параметр | Тип | Обов’язковий | Опис |
| - | - | - | - |
| `api_id` | UUID | ✅ | ID API (формат UUID, псевдоніми не підтримуються) |

## Приклади запитів

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

## Приклад відповіді (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": { "...": "..." } }
  }
}
```

## Опис полів відповіді

Інтерфейс деталей додатково містить, окрім [полів інтерфейсу списку](https://platform.acedata.cloud/documents/platform-api-list):

| Поле | Тип | Опис |
| - | - | - |
| `service` | object | Ключова інформація належної служби: `id`, `title`, `type`, `alias` |
| `products` | array | Список пов’язаних продуктів (зазвичай порожній, для використання операційною стороною) |
| `definition` | object | **Повне визначення специфікації OpenAPI 3.0**, містить `paths`, `components`, `info` тощо, і може безпосередньо передаватися в `openapi-generator` для генерування коду клієнта |

## Обробка помилок

| HTTP | code | Значення |
| - | - | - |
| 400 | `invalid` | `api_id` не є дійсним UUID |
| 404 | `not_found` | API не існує або вимкнено |

## Практичні поради

* **Поле `definition` дуже велике**: OpenAPI Schema одного API може містити сотні рядків JSON. Якщо потрібно лише створити індекс служб і Schema не потрібна, слід натомість використовувати [інтерфейс списку](https://platform.acedata.cloud/documents/platform-api-list).
* **Поширений спосіб використання для генерування 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
  ```
* **Відстеження змін API**: поле `updated_at` — це час останньої зміни schema. Підписка на це поле дає змогу автоматично повторно генерувати SDK у разі змін OpenAPI.

## Пов’язані інтерфейси

* [Отримання списку API платформи AceDataCloud](https://platform.acedata.cloud/documents/platform-api-list)
* [Отримання статистики викликів API платформи AceDataCloud](https://platform.acedata.cloud/documents/platform-api-usage)
* [Отримання деталей служби платформи AceDataCloud](https://platform.acedata.cloud/documents/platform-service-detail)
* [Отримання деталей документа платформи AceDataCloud](https://platform.acedata.cloud/documents/platform-document-detail) — використовуйте `document_id` для переходу до документації розробника з рендерингом


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