Get qiyaov Platform API Details

Retrieve complete information for a single API endpoint by API ID—compared with the list endpoint, it includes additional fields: definition (OpenAPI 3.0 Schema), service (details of the associated service), and products (associated products).

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

ℹ️ This endpoint belongs to the qiyaov Platform Management API, with the unified prefix https://api17.platform.acedata.cloud/api/v1/. For the complete endpoint index, see Get qiyaov Platform Documentation List.

Endpoint Overview

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

Both /apis/{id} and /apis/{id}/ are currently available; examples consistently use the form without a trailing slash.

Authentication Description

This endpoint is completely public and does not require an account token or login session.

Path Parameters

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

Request Examples

cURL

curl 'https://api17.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://api17.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"Associated service: {api['service']['title']} ({api['service']['alias']})")
print(f"Number of OpenAPI paths: {len(api.get('definition', {}).get('paths', {}))}")

Node.js

const apiId = 'afc7917f-d89f-4dc9-95c2-863936b02cad'
const r = await fetch(`https://api17.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 endpoint additionally includes the following fields on top of the list endpoint 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 use by the operations side)
definition object Complete OpenAPI 3.0 specification definition, including paths, components, info, etc.; 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 The API does not exist or is offline

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 create a service index and do not need the Schema, you should use the list endpoint instead.
  • Common usage for generating SDKs:
    # Get the OpenAPI file
curl -s 'https://api17.platform.acedata.cloud/api/v1/apis/<api_id>' | jq '.definition' > openapi.json

# Generate a Python client with openapi-generator-cli
openapi-generator-cli generate -i openapi.json -g python -o ./client
  • Track API changes: The updated_at field is the time when the schema was last changed. Subscribing to this field allows SDKs to be automatically regenerated when OpenAPI changes.