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

# Ottieni i dettagli dell'API della piattaforma AceDataCloud

> Platform API guide - Ace Data Cloud

Ottieni le informazioni complete di un singolo endpoint API tramite API ID — rispetto all'[interfaccia elenco](https://platform.acedata.cloud/documents/platform-api-list), include in più i campi `definition` (Schema OpenAPI 3.0), `service` (dettagli del servizio di appartenenza) e `products` (prodotti associati).

Adatto a scenari quali la generazione automatica di SDK, il fornire descrizioni degli strumenti a LLM Agent, il rendering dinamico di siti di documentazione e altri.

> ℹ️ Questa interfaccia appartiene alle **API di gestione della piattaforma AceDataCloud**, con prefisso unificato `https://platform.acedata.cloud/api/v1/`. Per l'indice completo delle interfacce, consulta [Ottieni l'elenco della documentazione della piattaforma AceDataCloud](https://platform.acedata.cloud/documents/platform-document-list).

## Panoramica dell'interfaccia

| Voce | Contenuto |
| - | - |
| Metodo | `GET` |
| URL | `https://platform.acedata.cloud/api/v1/apis/{api_id}` |
| Autenticazione | ❌ Pubblica |

`/apis/{id}` e `/apis/{id}/` sono entrambi attualmente disponibili; gli esempi utilizzano uniformemente il formato senza barra finale.

## Descrizione dell'autenticazione

Questa interfaccia è **completamente pubblica e non richiede token dell'account né stato di accesso**.

## Parametri di percorso

| Parametro | Tipo | Obbligatorio | Descrizione |
| - | - | - | - |
| `api_id` | UUID | ✅ | API ID (formato UUID, gli alias non sono supportati) |

## Esempi di richiesta

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

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

## Descrizione dei campi della risposta

L'interfaccia dei dettagli include inoltre, oltre ai [campi dell'interfaccia elenco](https://platform.acedata.cloud/documents/platform-api-list):

| Campo | Tipo | Descrizione |
| - | - | - |
| `service` | object | Informazioni principali del servizio di appartenenza: `id`, `title`, `type`, `alias` |
| `products` | array | Elenco dei prodotti associati (solitamente vuoto, utilizzato dal lato operativo) |
| `definition` | object | **Definizione completa della specifica OpenAPI 3.0**, inclusi `paths`, `components`, `info` e altri, utilizzabile direttamente con `openapi-generator` per generare codice client |

## Gestione degli errori

| HTTP | code | Significato |
| - | - | - |
| 400 | `invalid` | `api_id` non è un UUID valido |
| 404 | `not_found` | L'API non esiste o è stata dismessa |

## Suggerimenti pratici

* **Il campo `definition` è molto grande**: lo Schema OpenAPI di una singola API può contenere centinaia di righe JSON. Se serve solo creare un indice dei servizi e non è necessario lo Schema, è preferibile utilizzare l'[interfaccia elenco](https://platform.acedata.cloud/documents/platform-api-list).
* **Uso comune per generare 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
  ```
* **Tracciare le modifiche dell'API**: il campo `updated_at` indica l'ora dell'ultima modifica dello schema. Iscrivendosi a questo campo, è possibile rigenerare automaticamente l'SDK quando OpenAPI viene modificato.

## Interfacce correlate

* [Ottieni l'elenco delle API della piattaforma AceDataCloud](https://platform.acedata.cloud/documents/platform-api-list)
* [Ottieni le statistiche delle chiamate API della piattaforma AceDataCloud](https://platform.acedata.cloud/documents/platform-api-usage)
* [Ottieni i dettagli del servizio della piattaforma AceDataCloud](https://platform.acedata.cloud/documents/platform-service-detail)
* [Ottieni i dettagli della documentazione della piattaforma AceDataCloud](https://platform.acedata.cloud/documents/platform-document-detail) — usa `document_id` per passare alla documentazione per sviluppatori con rendering


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