跳至主要内容

开发者与 API

在 Socrates 上构建智能体。

自动化客户端所需的一切:强类型 OpenAPI 规范、带 PKCE 的 OAuth 2.0、作用域长效智能体密钥、MCP 服务器,以及结构化的机器可读索引。

快速入门

三步发起首次智能体调用。

步骤 01

选择认证方式

第三方智能体建议采用 OAuth 2.0 PKCE 授权流;第一方自动化任务可直接在 控制台 或通过 API 创建受限密钥。

Authorization: Bearer ak_<keyId>.<secret>
步骤 02

查阅 API 协议

所有公开接口均在 OpenAPI 3.0 规范 中完整定义,包含操作 ID、请求响应 Schema、错误码以及细粒度 OAuth 权限范围。

curl -s https://topodrive.top/openapi.json
步骤 03

发起调用

基础地址 https://app.topodrive.top。可先通过 GET /api/v2/health 探活。响应头附带 RateLimit-* 信息方便客户端自适应控频。

GET https://app.topodrive.top/api/v2/health

机器可读接口

发现索引。

Socrates 在标准化固定路径公布机器可读的协议和清单,供智能体抓取、开发者工具链及大语言模型自动识别。

资源名称 端点路径 格式
OpenAPI 规范 /openapi.json openapi+json
认证参考指南 /auth.md markdown
受保护资源元数据 (RFC 9728) /.well-known/oauth-protected-resource json
授权服务器元数据 (RFC 8414) /.well-known/oauth-authorization-server json
MCP 服务端 (流式 HTTP,只读工具) app.topodrive.top/api/mcp json-rpc 2.0
MCP 服务卡片 /.well-known/mcp/server-card.json json
A2A 智能体卡片 /.well-known/agent-card.json json
智能体技能索引 (v0.2.0) /.well-known/agent-skills/index.json json
Skill 技能包 (agentskills 格式) /SKILL.md markdown
API 目录 (RFC 9727 linkset) /.well-known/api-catalog linkset+json
大模型导航索引 /llms.txt · /llms-full.txt plain text

架构约定与规范

所有端点的通用设计。

结构化错误响应

错误采用统一格式:{"code": "MACHINE_READABLE_CODE", "message": "human detail", "detail": …},并严格对应 400 校验失败、401 未认证、403 权限不足、404 未找到、429 频控等标准 HTTP 状态。

细粒度作用域

OAuth 令牌与智能体密钥包含明确权限集合(如 chat:read/writesessions:* 等)。读操作要求 :read,写操作要求 :write

写操作幂等支持

对所有写入请求支持携带 Idempotency-Key: <uuid>;24 小时内的重复请求将直接返回原先的结果,避免重复执行。

自适应频控响应头

每个接口响应均返回 RateLimit-LimitRateLimit-RemainingRateLimit-Reset,便于客户端合理自控速率。

游标分页

列表接口返回 {items, cursor, hasMore} 结构;循环传入 ?cursor=<cursor> 即可平滑翻页。

确定性版本迭代

接口废弃前会通过 Sunset 响应头标明时间,并在动态公告中至少提前 90 天通知。

集成与支持

集成遇到疑问?

欢迎致信 help@addtech.site — 附带您的请求 ID(X-Request-Id 响应头),我们将精准追踪具体调用。