身份验证
在 Studio 中创建 Direct API 密钥,选择其权限范围和积分上限,并在每个请求中携带它。
每个请求都以 bearer token 的形式携带一个组织 API 密钥。
Authorization: Bearer mor_live_9f2c…密钥属于组织,而不属于创建它的人。组织的每位管理员都可以查看和吊销它,即使创建者离开团队,它也会继续有效。密钥在被吊销、过期、创建者的账号被停用,或 Morphic 为该组织关闭 Direct API 时失效。
创建密钥
只有在 Morphic 为你的组织开通 Direct API 后,Direct API 的权限范围才会出现。参见 获取访问权限。
- 在 Morphic Studio 中,打开组织下拉菜单(左上角的 Morphic 标志),然后选择“设置”。
- 在左侧边栏中,点击“API 密钥”。只有管理员能看到此选项卡。
- 点击“新建密钥”。
- 填写“名称”,选择密钥所需的“权限范围”,如果密钥不应永久有效,再设置“有效期”。
- 在“积分上限”下,设置该密钥总共可以消耗的积分,并可选择设置每日和每月上限。
- 勾选“我同意Morphic 使用条款(包括开发者 API 部分)”。这将代表组织接受 使用条款。
- 点击“创建密钥”,然后将密钥复制到你的密钥管理器中。它只显示一次。
任何持有该密钥的人都可以在密钥上限内消耗你组织的积分。切勿将密钥放在浏览器、移动应用或公开代码仓库中。
密钥格式
mor_live_<64 hex characters>前缀可以让你和密钥扫描工具知道该密钥属于哪个部署环境。
权限范围
密钥只能访问其权限范围允许的工具。请选择最小的范围集合。
| 权限范围 | Studio 中的标签 | 授予 |
|---|---|---|
projects:read | 读取项目及其文件 | 列出项目、工作流和 Compose 时间线 |
assets:read | 查找和读取素材 | 列出素材库,读取生成任务及其状态、角色 |
assets:write | 上传和编辑素材 | 通过 URL 传入媒体,创建 Compose 时间线 |
generations:write | 生成图片、视频和音频(消耗积分) | 所有启动、编辑或分析媒体的工具 |
调用密钥权限范围之外的工具会返回 403 insufficient_scope,并在 data.required_scopes 中指出缺少的权限范围。不需要权限范围的端点和工具(例如 list_voices 和 /me)对所有密钥开放。工具目录 列出了每个工具所需的权限范围。
积分上限
每个密钥都带有在创建时设置的消费上限。管理员之后可以通过“编辑上限”更改它们。
| 上限 | 必填 | 时间窗口 |
|---|---|---|
total_credit_limit | 是 | 密钥的整个生命周期 |
monthly_credit_limit | 否 | 自然月,UTC |
daily_credit_limit | 否 | 自然日,UTC |
- 会使密钥超出任一上限的付费调用,会在任何工作开始之前被拒绝,并返回
402 api_key_credit_limit_reached;data.period说明是哪个上限。 - 组织自身的余额同样适用:组织无法支付的调用会被拒绝,并返回
402 insufficient_credits。 GET /v1/direct/me返回密钥的上限和当前已用额度。参见 积分与用量。
轮换密钥
- 创建新密钥。
- 部署新密钥。
- 通过“吊销密钥”吊销旧密钥。
一个组织最多可同时拥有 10 个有效密钥,因此轮换时无需中断服务。
如果您遇到任何问题或有任何疑问,欢迎随时联系我们。我们很乐意提供帮助。请发送邮件至 support@morphic.com.