面向开发者的 API 参考

将您自己的应用连接到工作区:REST API、其密钥和作用域、错误、限流以及 Webhook。

在哪里找到

⚙️ 设置 › API 参考 · 首页 › 资源 › API 参考

打开此界面
API 参考,含侧边菜单、身份验证和端点。

步骤

  1. 在侧边栏中打开“API 参考”,或在首页的“资源”菜单中打开“API 参考”。
  2. 从“从这里开始”入手:“基础 URL 与约定”、“身份验证”和“作用域”。
  3. 按分组查找“端点”;每个端点都附有示例,展示其参数、请求体、响应和错误。
  4. 上线前请阅读“错误与状态码”、“限流”和“Webhook(外发)”。“OpenAPI JSON”可下载完整规范。

故障排除

如何获取 API 密钥?

密钥按申请为您的工作区签发;目前还无法在应用中创建。您工作区的密钥列在 AI 区域的开发者页面上,管理工作区的人员也可以在那里添加和测试 Webhook 接收地址。

小贴士

  • 只从您的服务器调用 API。切勿将密钥放在网页或移动应用中。

须知

  • 无需登录即可阅读 API 参考。

相关使用指南

免费开始 主页