API 密钥

创建、审核和撤销你组织用于直接 API 和合作伙伴 API 的 API 密钥。

API 密钥可让另一个系统在无人打开 Morphic 的情况下使用它:通过合作伙伴 API启动你的工作流,或通过直接 API生成和编辑媒体。“API 密钥”标签页仅管理员可见。

直接前往: studio.morphic.com/settings/api-keys

API 密钥页面,显示基础 URL、组织 ID 和创建密钥按钮

密钥归组织所有

而不是归创建它的人所有。即使他们离开,它也会继续工作,所有管理员都能看到它的列表并将其撤销,并且它启动的每次运行都会计入组织账单。

创建密钥

打开该标签页

打开组织下拉菜单(左上角的 Morphic 标志),选择 Settings,然后点击左侧边栏中的“API 密钥”

已选中 API 密钥的设置侧边栏,它是组织相关页面中的最后一项

点击 New key

给它起一个你一个月后还能认出的名字:按它所在的系统命名,不要叫“key 2”。

新 API 密钥表单:名称、权限范围、工作流、积分上限和有效期

选择它的作用范围

只选这个密钥需要的权限。前三项用于合作伙伴 API,其余用于直接 API;Morphic 为你的组织开通直接 API 后,这些选项才会出现。

  • workflows:read:读取工作流及其所接收的输入
  • runs:write:启动运行,并注册 webhook 端点
  • runs:read:读取某次运行的状态及其完成的资产,并列出 webhook 端点
  • projects:read:读取项目及其文件
  • assets:read:查找和读取资产
  • assets:write:上传资产并编辑它们
  • generations:write:生成图像、视频和音频,这会消耗积分

然后勾选复选框,同意 Morphic 使用条款,包括其中的开发者 API 部分。

将其限制为特定工作流

可选,而且值得这样做。勾选“将此密钥限定到特定工作流”并选择它们。任何其他内容的运行都会被拒绝,这样即使密钥泄露也能将损害限制在最小。若不勾选,此密钥可运行组织能运行的每个工作流。

在新密钥表单中勾选了“将此密钥限制为特定工作流”,下方有搜索框和可供选择的组织工作流

设置其额度上限

设置“此密钥可使用的积分总量”,或选择“无总额上限(不限)”。按日和按月上限是可选的;留空其中一个即可使该时间窗口不设上限。

建议设置总额度。总额度应按集成在下次有人检查之前应该能够花费多少来设置,而不是按它实际会花多少来设置。它是断路器,不是预算。某个时间窗口的上限不能高于总额度,因为总额度会先起约束作用。

使用该密钥启动的运行所消耗的积分会计入组织,并算到启动它的那个密钥名下。即使之后有人进入聊天接管,该密钥启动的运行仍会继续计入它。否则,同事回答了一个问题,就会把该次运行的其余消耗转到组织的通用额度池。该人的个人额度上限(如果有)也仍然适用。

一天是 UTC 日,一个月是 UTC 日历月。任何会使密钥超出其任一上限的扣费都会被拒绝,消息中会写明该密钥及其触发的上限。

选择过期时间

永不过期、30 天、90 天或 1 年。过期的密钥会自动停止认证,这是最便宜的轮换方式。

复制密钥

密钥秘密只会显示一次。Morphic 只保存它的哈希,因此无法再次显示。请在关闭对话框前将其复制到你的密钥管理器中。

任何持有该密钥的人都可以启动会消耗你组织积分的运行。切勿提交到代码仓库,切勿放在浏览器中,切勿通过电子邮件或聊天发送。如果泄露了,就撤销它。

列表显示内容

每个密钥都会显示其名称、是正式密钥还是测试密钥、其秘密的前几个字符(足以与你自己的记录进行匹配)、其作用范围、它可以运行多少个工作流、其额度上限,以及上次使用时间。已过期和已撤销的密钥仍会保留在列表中,以便你查看它们的情况。

一个组织最多可同时持有 10 个可用于身份验证的密钥。已过期和已撤销的密钥不计入其中。

更改密钥的额度上限

  1. 在列表中找到该密钥。
  2. 点击其旁边的“…”菜单并选择“编辑上限”。
  3. 修改总额度,或按日/按月上限,然后保存。清空某个上限即可解除它。

新上限会从该密钥的下一次扣费开始生效,包括它已经启动的运行中的扣费。这样当某次运行卡在密钥上限时,这就是修复方法,而且对已撤销的密钥也有效:它启动的运行仍会继续消耗其额度,因此降低其上限就是停止它们的方式。

撤销密钥

  1. 在列表中找到该密钥。
  2. 点击其旁边的“…”菜单并选择“吊销密钥”。
  3. 确认。

使用它的调用会在几秒内开始失败。已经在进行中的运行会完成,并且仍会计费。撤销无法撤回。若要轮换密钥,请先创建替代密钥,把流量切换过去,然后再撤销旧密钥。

支出显示在哪里

通过 API 消耗的积分会计入组织,并归因于消耗它们的密钥。在积分用量中,API 的支出显示为另一位成员“API”,由具名密钥产生的扣费显示为“API · ”加上该密钥的名称。

  • 在“概览”中打开“按密钥拆分 API”,可按密钥查看 API 的支出明细。
  • 如果合作伙伴 API 的运行带有不属于你成员的 user_email,它会按该邮箱显示在“用量记录”中,这样你就能看到自己的每位用户花了多少。user_email 属于某位成员的运行,则算作该成员的支出。请参阅启动工作流运行。

如果您遇到任何问题或有任何疑问,欢迎随时联系我们。我们很乐意提供帮助。请发送邮件至 support@morphic.com.

本页内容