Get the API List under the AceDataCloud Platform Service

Obtain all API endpoint information (path, pricing, stage, associated documentation, etc.) mounted under the service by service ID. The difference from Getting the AceDataCloud Platform API List: this interface only returns APIs under a specified service, while the former returns all APIs across services.

Applicable scenarios: the "APIs included in this service" panel on the right side of the service detail page, enumeration of Agent tool capabilities, generation of documentation site navigation, etc.

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

Interface Overview

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

Authentication Description

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

Path Parameters

Parameter Type Required Description
service_id UUID ✅ Service ID. Note: must be in UUID format, alias is not supported—this is a historical legacy

⚠️ This is different from the Service Detail Interface: the detail interface supports both UUID and alias, while this interface only supports UUID. If you only have an alias, first call the detail interface to get the UUID and then use it.

Query Parameters

Parameter Type Required Default Description
limit integer No 10 Number of items per page, maximum 100
offset integer No 0 Offset
stage string No — Filter by stage: Alpha/Beta/Stable/Deprecated
ordering string No rank Sorting field, prefix - for descending

Request Example

cURL

curl 'https://platform.acedata.cloud/api/v1/services/8efa1d83-9b75-4562-b44a-af95ce563d05/apis/' \
  -H 'accept: application/json'

# Only view stable version APIs
curl 'https://platform.acedata.cloud/api/v1/services/8efa1d83-9b75-4562-b44a-af95ce563d05/apis/?stage=Stable' \
  -H 'accept: application/json'

Python

import requests

service_id = "8efa1d83-9b75-4562-b44a-af95ce563d05"
resp = requests.get(
    f"https://platform.acedata.cloud/api/v1/services/{service_id}/apis/",
    headers={"accept": "application/json"},
    params={"limit": 50},
    timeout=10,
)
data = resp.json()
print(f"There are {data['count']} APIs under this service")
for api in data["items"]:
    print(f"  [{api['stage']:>10}] {api['title']:30s} {api['path']}")

Node.js

const serviceId = '8efa1d83-9b75-4562-b44a-af95ce563d05'
const r = await fetch(`https://platform.acedata.cloud/api/v1/services/${serviceId}/apis/`)
const { count, items } = await r.json()
console.log(`Number of APIs: ${count}`)
items.forEach((api) => console.log(`${api.title} -> ${api.path}`))

Response Example (HTTP 200)

{
  "count": 7,
  "items": [
    {
      "id": "e4fbc3b6-4f44-48fb-a049-40f5c27c7cd3",
      "document_id": "20945baf-b263-457b-be5f-0332c2180a57",
      "service_id": "8efa1d83-9b75-4562-b44a-af95ce563d05",
      "name": "Face Analyze API",
      "title": "Facial Feature Localization API",
      "path": "/face/analyze",
      "path2": null,
      "introduction": "This API can be used to locate facial features in the requested image (also known as facial keypoint localization), calculating 90 points that form the facial contour.",
      "cost": [
        { "conditions": { "==": [1, 1] }, "consumption": 0.0025 }
      ],
      "stage": "Stable",
      "rank": 10,
      "tags": [],
      "metadata": null,
      "created_at": "2024-08-06T03:20:03.105765Z",
      "updated_at": "2026-04-26T16:16:56.579972Z"
    }
  ]
}

Response Field Description

Field Type Description
count integer Total number of APIs that meet the criteria
items array API list
id UUID Unique identifier for the API
document_id UUID Associated developer document ID (can be used to jump to Get AceDataCloud Platform Document Details)
service_id UUID Service ID (same as path parameter)
name string API English name
title string API display title (localized)
path string API call path, the business interface prefix is https://api.acedata.cloud, for example, /face/analyze the complete URL is https://api.acedata.cloud/face/analyze
path2 string Backup path, may be null
introduction string A brief introduction
cost array Pricing rules (JsonLogic format). conditions match request parameters, and if matched successfully, consumption is charged
stage string Lifecycle stage: Alpha, Beta, Stable, Deprecated
rank integer Sorting weight
tags array Tags
metadata object Extended metadata
created_at string Creation time
updated_at string Last updated time

ℹ️ This interface does not return the definition (OpenAPI Schema) field—the schema is large and rarely needed. To view the schema, please call Get AceDataCloud Platform API Details.

Error Handling

HTTP Code Meaning
400 invalid service_id is not a valid UUID format
404 not_found Service does not exist or has been taken offline

Practical Tips

  • Do not use APIs marked with stage=Deprecated in new projects, as they will be removed within the next 6 months.
  • Multiple path services: A few services (such as ChatDoc) have multiple interface paths, and this interface will return multiple records.
  • Automatically generate SDK: The common practice is to first call services/?type=Api, then call this interface for each service to obtain api_ids, and finally call /apis/{id} to get the OpenAPI Schema to generate client code using openapi-generator.