1. API 鉴权
平台 API 通过 Bearer Token 鉴权。用户登录后,前端会保存 token,后续请求需在 HTTP Header 中携带 `Authorization: Bearer <token>`。
- 登录接口:`POST /api/auth/login`
- 注册接口:`POST /api/auth/register`
- 所有业务接口需携带 Authorization Header
- Token 长期有效,修改密码后建议重新登录
2. 常见调用示例
以下是几个高频 API 调用示例:
- 获取用户信息:`GET /api/users/me`
- 查询钱包:`GET /api/billing/wallet`
- 调用 AI 员工:`POST /api/agents/invoke`(body: { agentType, prompt })
- 模型对话:`POST /api/models/chat`(body: { model, messages, temperature, maxTokens })
- 流式对话:`POST /api/models/chat/stream`(SSE 流式返回)
3. Webhook 配置
企业用户可在后台配置 Webhook URL,用于接收任务状态变更、支付结果、合规提醒等事件。Webhook 请求会以 JSON 格式 POST 到指定地址,并附带签名供验证。
4. 错误处理
平台 API 统一返回 JSON 格式响应。错误时 HTTP 状态码 ≥ 400,body 中包含 `error` 字段描述原因。
- 400:请求参数错误
- 401:未登录或 token 失效
- 403:权限不足
- 404:资源不存在
- 500:服务端异常,建议稍后重试