Obtenir les détails de l’API de la plateforme AceDataCloud

Obtenez les informations complètes d’un seul point de terminaison API via l’ID d’API — par rapport à l’interface de liste, elle ajoute les champs definition (Schéma OpenAPI 3.0), service (détails du service auquel elle appartient) et products (produits associés). Convient aux scénarios tels que la génération automatique de SDK, l’alimentation des descriptions d’outils pour les Agents LLM, le rendu dynamique de sites de documentation, etc.

ℹ️ Cette interface fait partie de l’API de gestion de la plateforme AceDataCloud, avec le préfixe unifié https://platform.acedata.cloud/api/v1/. Pour l’index complet des interfaces, consultez Obtenir la liste des documents de la plateforme AceDataCloud.

Aperçu de l’interface

Élément	Contenu
Méthode	`GET`
URL	`https://platform.acedata.cloud/api/v1/apis/{api_id}`
Authentification	❌ Publique

/apis/{id} et /apis/{id}/ sont actuellement tous deux disponibles ; les exemples utilisent uniformément la forme sans barre oblique finale.

Instructions d’authentification

Cette interface est entièrement publique, aucun jeton de compte ni état de connexion n’est requis.

Paramètres de chemin

Paramètre	Type	Obligatoire	Description
`api_id`	UUID	✅	ID d’API (format UUID, les alias ne sont pas pris en charge)

Exemples de requêtes

cURL

curl 'https://platform.acedata.cloud/api/v1/apis/afc7917f-d89f-4dc9-95c2-863936b02cad' \
  -H 'accept: application/json'

Python

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

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)

Exemple de réponse (HTTP 200)

{
  "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": { "...": "..." } }
  }
}

Description des champs de réponse

L’interface de détails inclut, en plus des champs de l’interface de liste :

Champ	Type	Description
`service`	object	Informations principales du service auquel elle appartient : `id`, `title`, `type`, `alias`
`products`	array	Liste des produits associés (généralement vide, destinée à l’équipe des opérations)
`definition`	object	Définition complète de la spécification OpenAPI 3.0, incluant `paths`, `components`, `info`, etc., qui peut être directement fournie à `openapi-generator` pour générer le code client

Gestion des erreurs

HTTP	code	Signification
400	`invalid`	`api_id` n’est pas un UUID valide
404	`not_found`	L’API n’existe pas ou a été retirée

Conseils pratiques

Le champ definition est très volumineux : le schéma OpenAPI d’une seule API peut contenir plusieurs centaines de lignes JSON. Si vous souhaitez uniquement créer un index de services et n’avez pas besoin du schéma, utilisez plutôt l’interface de liste.

Utilisation courante pour générer un SDK :

# 拿到 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

Suivre les modifications de l’API : le champ updated_at correspond à la dernière date de modification du schéma. S’abonner à ce champ permet de régénérer automatiquement le SDK lors de modifications d’OpenAPI.

Interfaces associées

Obtenir la liste des API de la plateforme AceDataCloud
Obtenir les statistiques d’utilisation des API de la plateforme AceDataCloud
Obtenir les détails du service de la plateforme AceDataCloud
Obtenir les détails du document de la plateforme AceDataCloud — utilisez document_id pour accéder à la documentation développeur avec rendu

Démarrage

Chat IA

Image IA

Vidéo IA

Audio IA

Web & Données

CAPTCHA

Identité

Coding

Autres guides

Obtenir les détails de l’API de la plateforme AceDataCloud

Aperçu de l’interface

Instructions d’authentification

Paramètres de chemin

Exemples de requêtes

cURL

Python

Node.js

Exemple de réponse (HTTP 200)

Description des champs de réponse

Gestion des erreurs

Conseils pratiques

Interfaces associées

​Aperçu de l’interface

​Instructions d’authentification

​Paramètres de chemin

​Exemples de requêtes

​cURL

​Python

​Node.js

​Exemple de réponse (HTTP 200)

​Description des champs de réponse

​Gestion des erreurs

​Conseils pratiques

​Interfaces associées

Aperçu de l’interface

Instructions d’authentification

Paramètres de chemin

Exemples de requêtes

cURL

Python

Node.js

Exemple de réponse (HTTP 200)

Description des champs de réponse

Gestion des erreurs

Conseils pratiques

Interfaces associées