Ultineo AI 的 API
从您自己的软件运行目录中的应用。API 通过 HTTPS 使用 JSON，以项目密钥验证每次调用，并以相同格式响应所有调用。
围绕三种资源构建
- 目录
已发布的应用，按使用频率从高到低排列，并附上每个应用所需的输入字段。
- 运行
一次调用携带输入启动应用，另一次调用读取该运行及其回答。
- 密钥
带有权限范围、可选有效期以及可停用状态的项目密钥。
身份验证与权限范围
- Bearer 密钥
每次调用都在 Authorization 请求头中发送您的项目密钥，且仅通过 HTTPS 传输。
- 仅限一个项目
一把密钥只绑定一个项目，无论发出何种请求，都无法读取或写入其他项目的数据。
- 以哈希值存储
系统只保存密钥的哈希值，因此完整密钥只显示一次。密钥丢失后会被替换，永远无法找回。
启动运行并读取回答
- 创建
指定应用，并为每个输入字段提供一个值，以目录返回的字段名作为键。
- 跟踪
运行是异步的：请反复读取该运行，直到其状态变为已完成或已失败。这两种状态都是最终状态。
- 读取
已完成的运行包含其回答、耗时以及输入和输出的 Token 数。
所有响应采用统一格式
- 始终是相同的三个字段
无论成功还是失败，每个响应都包含状态码、简短标题和返回内容。
- 稳定的消息
错误消息是固定的英文字符串，会指出缺少的权限范围或被拒绝的值。
- 明确的套餐限制
套餐不涵盖的调用，或会超出额度的调用，将以专属的状态码被拒绝。
关于 API 的常见问题
付费套餐。免费套餐可以使用应用，但不包含 API。
不会。指令归应用所有者所有。API 返回的是输入字段，也就是调用方需要填写的内容。
创建运行后会立即返回新的状态。请反复读取该运行，直到其完成，即可获得回答。
可以。每把密钥都带有权限范围和可选有效期，且密钥永远无法创建权限范围比自身更大的另一把密钥。