0%

获取 API 列表

获取平台上所有可用的 API 接口列表。每个 API 属于一个服务(Service),包含名称、路径、定价规则等信息。

此接口无需身份验证

接口说明

内容
方法 GET
路径 /api/v1/apis/
鉴权 无需

查询参数

参数 类型 必填 说明
service_id string 按服务 ID 过滤
id string API ID(UUID),支持多个
limit integer 每页返回数量,默认 10
offset integer 偏移量,默认 0

请求示例

1
2
3
curl -X GET \
-H "accept: application/json" \
"https://platform.acedata.cloud/api/v1/apis/?limit=2"

响应示例(HTTP 200)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
{
"count": 134,
"items": [
{
"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,
"created_at": "2023-09-03T17:55:48.179195Z",
"updated_at": "2026-04-26T16:16:35.579082Z",
"tags": [],
"metadata": null,
"definition": "<OpenAPI 3.0 定义,已省略>"
}
]
}

字段说明

字段 类型 说明
count integer 符合条件的 API 总数
items array API 列表
id string API 唯一标识(UUID)
document_id string 关联的文档 ID
service_id string 所属服务 ID
name string API 名称(英文)
title string API 标题(显示用)
path string API 调用路径,如 /face/analyze
path2 string 备用路径,可能为 null
introduction string API 简介
cost array 定价规则(JsonLogic 格式)
stage string 阶段:BetaStable
rank integer 排序优先级
tags array 标签列表
metadata object 扩展元数据

代码示例

1
2
3
4
5
6
7
8
9
10
11
12
import requests

url = "https://platform.acedata.cloud/api/v1/apis/"
headers = {"accept": "application/json"}
params = {"limit": 20}

response = requests.get(url, headers=headers, params=params)
data = response.json()

print(f"共 {data['count']} 个 API")
for api in data["items"]:
print(f" {api['title']} - {api['path']} ({api['stage']})")

相关接口