Get AceDataCloud Platform API Details

Obtain complete information about a single API endpoint by API ID—providing additional fields definition (OpenAPI 3.0 Schema), service (service details), and products (associated products) compared to the list interface.

Applicable for scenarios such as automatically generating SDKs, feeding tool descriptions to LLM Agents, and dynamically rendering documentation sites.

ℹ️ This interface belongs to the AceDataCloud Platform Management API, with a unified prefix of https://platform.acedata.cloud/api/v1/. For a complete index of interfaces, see Get AceDataCloud Platform Documentation List.

Interface Overview

Item Content
Method GET
URL https://platform.acedata.cloud/api/v1/apis/{api_id}
Authentication ❌ Public

⚠️ The URL should not have a trailing slash—/apis/{id} is not /apis/{id}/.

Authentication Description

This interface is completely public, no account token or login state is required.

Path Parameters

Parameter Type Required Description
api_id UUID ✅ API ID (UUID format, aliases not supported)

Request Example

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"Path: {api['path']}")
print(f"Service: {api['service']['title']} ({api['service']['alias']})")
print(f"OpenAPI Path Count: {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)

Response Example (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": "After creating a knowledge repository, this API can be used to add, query, modify, or delete documents in the knowledge repository.",
  "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 Q&A",
    "type": "Api",
    "alias": "chatdoc"
  },
  "products": [],
  "definition": {
    "openapi": "3.0.0",
    "info": { "title": "ChatDoc Documents API", "version": "0.1" },
    "paths": {
      "/chatdoc/documents": {
        "post": { "...": "..." }
      }
    },
    "components": { "schemas": { "...": "..." } }
  }
}

Response Field Description

The detail interface additionally includes the following fields on top of the list interface fields:

Field Type Description
service object Core information of the associated service: id, title, type, alias
products array List of associated products (usually empty, for operational use)
definition object Complete OpenAPI 3.0 specification definition, including paths, components, info, etc., which can be directly fed to openapi-generator to generate client code

Error Handling

HTTP Code Meaning
400 invalid api_id is not a valid UUID
404 not_found API does not exist or has been deprecated
500 — Trailing slash mistakenly added to URL, remove it and retry

Practical Tips

  • The definition field is very large: The OpenAPI Schema for a single API may contain hundreds of lines of JSON. If you only need to index services and do not require the Schema, you should use the list interface instead.
  • Common usage for generating SDKs:
    # Obtain the OpenAPI file
curl -s 'https://platform.acedata.cloud/api/v1/apis/<api_id>' | jq '.definition' > openapi.json

# Use openapi-generator-cli to generate a Python client
openapi-generator-cli generate -i openapi.json -g python -o ./client
  • Track API changes: The updated_at field indicates the last time the schema was changed. Subscribing to this field can automatically regenerate the SDK when OpenAPI changes.