Get the qiyaov Platform API List

Returns API endpoints visible on the current site in a paginated manner. Suitable for finding APIs by business path, service, or release stage; if you only need the complete definition of one API, please directly call API Details.

API Overview

Item Content
Method GET
URL https://api17.platform.acedata.cloud/api/v1/apis/
Authentication Public, no account token required
Pagination count + items

Query Parameters

Parameter Type Required Description
path string No Exact match for path or path2
service string No Service alias or UUID
stage string No Filter by release stage; multiple values can be passed repeatedly
limit integer No Number of items per page, maximum 100
offset integer No Pagination offset

id, service_id, and tag are currently not list filter parameters; passing them will not produce corresponding filtering effects.

curl --get 'https://api17.platform.acedata.cloud/api/v1/apis/' \
  --data-urlencode 'service=midjourney' \
  --data-urlencode 'stage=Production' \
  --data-urlencode 'limit=20' \
  -H 'Accept: application/json'

import requests

response = requests.get(
    "https://api17.platform.acedata.cloud/api/v1/apis/",
    params={"service": "midjourney", "limit": 20},
    timeout=30,
)
response.raise_for_status()
for api in response.json()["items"]:
    print(api["id"], api["method"], api["path"])

Response Description

The online response uses {count, items}. Each list item currently includes API model fields, as well as:

  • document_id: Associated developer document ID, may be empty;
  • service_id / service: Primary service ID and summary, may be empty;
  • definition: OpenAPI definition, which may be large;
  • method, path, path2, stage, cost, tags, metadata, etc.

The list serializer currently includes definition; when retrieving the full catalog, pagination and timeouts should be set. Fields may be added in a backward-compatible manner, and clients should only read the required fields.

Next Steps