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

# Hämta API-detaljer för AceDataCloud-plattformen

> Platform API guide - Ace Data Cloud

Hämta fullständig information om en enskild API-slutpunkt via API-ID — jämfört med [listgränssnittet](https://platform.acedata.cloud/documents/platform-api-list) tillkommer fälten `definition` (OpenAPI 3.0 Schema), `service` (information om tillhörande tjänst) och `products` (relaterade produkter).

Lämpligt för scenarier som automatisk generering av SDK:er, matning av verktygsbeskrivningar till LLM Agent och dynamisk rendering av dokumentationswebbplatser.

> ℹ️ Detta gränssnitt tillhör **AceDataCloud-plattformens hanterings-API**, med det enhetliga prefixet `https://platform.acedata.cloud/api/v1/`. Se [Hämta dokumentlistan för AceDataCloud-plattformen](https://platform.acedata.cloud/documents/platform-document-list) för ett komplett gränssnittsindex.

## Gränssnittsöversikt

| Objekt | Innehåll |
| - | - |
| Metod | `GET` |
| URL | `https://platform.acedata.cloud/api/v1/apis/{api_id}` |
| Autentisering | ❌ Offentlig |

`/apis/{id}` och `/apis/{id}/` är båda för närvarande tillgängliga; exemplen använder konsekvent formen utan avslutande snedstreck.

## Autentiseringsbeskrivning

Detta gränssnitt är **helt offentligt och kräver varken kontotoken eller inloggningssession**.

## Sökvägsparametrar

| Parameter | Typ | Obligatorisk | Beskrivning |
| - | - | - | - |
| `api_id` | UUID | ✅ | API-ID (UUID-format, alias stöds inte) |

## Begäransexempel

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

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

## Beskrivning av svarsfält

Detaljgränssnittet innehåller, utöver fälten i [listgränssnittet](https://platform.acedata.cloud/documents/platform-api-list), även:

| Fält | Typ | Beskrivning |
| - | - | - |
| `service` | object | Kärninformation om tillhörande tjänst: `id`, `title`, `type`, `alias` |
| `products` | array | Lista över relaterade produkter (vanligtvis tom, för användning på driftssidan) |
| `definition` | object | **Fullständig OpenAPI 3.0-specifikationsdefinition**, innehåller `paths`, `components`, `info` osv. och kan direkt matas till `openapi-generator` för att generera klientkod |

## Felhantering

| HTTP | code | Betydelse |
| - | - | - |
| 400 | `invalid` | `api_id` är inte en giltig UUID |
| 404 | `not_found` | API:t finns inte eller har tagits offline |

## Praktiska tips

* **Fältet `definition` är mycket stort**: OpenAPI Schema för ett enskilt API kan omfatta hundratals rader JSON. Om du bara behöver skapa ett tjänsteindex och inte behöver Schema, bör du använda [listgränssnittet](https://platform.acedata.cloud/documents/platform-api-list) i stället.
* **Vanlig användning för att generera 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
  ```
* **Spåra API-ändringar**: Fältet `updated_at` är tidpunkten för den senaste ändringen av schemat. Genom att prenumerera på detta fält kan SDK:n automatiskt genereras på nytt när OpenAPI ändras.

## Relaterade gränssnitt

* [Hämta API-listan för AceDataCloud-plattformen](https://platform.acedata.cloud/documents/platform-api-list)
* [Hämta API-anropsstatistik för AceDataCloud-plattformen](https://platform.acedata.cloud/documents/platform-api-usage)
* [Hämta tjänstedetaljer för AceDataCloud-plattformen](https://platform.acedata.cloud/documents/platform-service-detail)
* [Hämta dokumentdetaljer för AceDataCloud-plattformen](https://platform.acedata.cloud/documents/platform-document-detail) — använd `document_id` för att gå till utvecklardokumentationen med rendering


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