> ## 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 по API ID — по сравнению с [интерфейсом списка](https://platform.acedata.cloud/documents/platform-api-list) дополнительно включает поля `definition` (схема OpenAPI 3.0), `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 | ✅ | API ID (формат 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 одного 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.