Skip to main content
公共 API 托管在您 Failproof AI 控制台域名下的 /v1 路径。

​
创建密钥并发起请求

  1. 打开 Administration → Keys，选择 Create key，并选择涵盖该集成所需的最小权限预设。
  2. 仅在必要时添加单独授权，创建密钥后复制其一次性密钥。
  3. 向 /v1/sessions 发送测试请求，并在 Keys 页面确认密钥处于活跃状态。
  4. 当集成更换归属时，通过其操作菜单轮换或禁用密钥。 新建 API 密钥抽屉，包含权限预设和单独授权选项。
创建抽屉如上图所示。一次性密钥仅在您选择 create 后显示；请在关闭确认弹窗前完成复制。
密钥的作用范围限定于组织和权限集。若请求缺少端点所需的权限，将返回 403 并指明缺失的权限项。

​
组织选择

组织密钥会自动作用于其所属组织。实例级密钥可以在每次请求时指定操作的组织：
在打开 Administration → Keys 前，先使用控制台顶部的组织切换器选择目标组织。在该处创建的密钥归属于所选组织。在将凭据复制到自动化流程前，请确认 URL 中的组织 slug 与密钥详情一致。
请使用本节中生成的端点页面查阅当前路径、参数、权限要求及状态码。该规范由服务器路由注解生成，并经过 /v1 路由器的校验。 当前规范已完整覆盖路由、方法、参数、权限及状态码。部分响应体有意未设置类型，因为服务器仍以动态 JSON 方式构造它们。在为没有响应 schema 的端点生成强类型客户端之前，请先检查实际响应结构。 JSON 写入请求需使用 Content-Type: application/json。401 表示身份验证信息缺失或无效，403 表示身份有效但缺少所需权限，404 表示资源不存在或在当前组织下无法访问，409 表示状态冲突，422 表示字段或权限值无效。错误响应包含人类可读的错误信息；权限失败时还会指明所需的授权项。
策略执行的部署管理有意置于常规公共 /v1 接口之外。请使用官方支持的 Cloud 部署工作流。