ДокументацияНачало работыAPI Key
API Key
介绍本站API Key的相关概念及规则
什么是API Key
API Key是本站提供的一种用于调用开放API接口的身份凭证,用户可以通过注册账号并创建API Key,本平台的 API Key 以 sk-sole- 开头。
API Key的创建和删除均可以在API Key管理中进行。
一定要注意保管您的API Key,泄露将可能导致您的账户余额被盗刷! 如果您的API Key疑似泄露,请立即到API Key管理中进行停用或删除!
创建 API Key 时的相关选项与规则
名称
您可以自定义 API Key 的名称,方便您后续管理。
调度分组
本平台提供多家上游服务商,您可通过选择调度分组来决定该 API Key 的可用来自哪些上游服务商的模型。
默认不选的情况下,该 API Key 可调用本平台提供的所有上游供应商模型,见模型广场
路由偏好
本平台提供多种路由偏好方案供您选择:
- 智能路由(默认):管理员会根据服务商来源进行优质货源标记,此路由偏好将优先使用被标记的优质来源。
- 最省费用:即使您使用同一个模型,由于上游供应商来源有些许差异,不同来源的计费可能会有差异。选择此路由偏好将优先使用计费更低的货源。
- 最低延迟:此路由偏好将优先使用延时测试更短的货源。
- 最稳定:此路由偏好将优先使用最近统计请求成功率最高的货源。
消费额度上限
平台会帮您以Credits统计每条 API Key 的消费情况,您可以对每一条 API Key 进行单独的消费限额设置,当消费达到限额后该 Key 请求被拒(HTTP 402)。
设置为 0 时视作不限额。
过期时间
您可以设置 API Key 的过期时间,过期时间过后,API Key 将被自动停用。适合临时接入或第三方交付场景。
留空时视作不设置过期时间,永久有效
访问IP白名单
您可以设置 API Key 的访问IP白名单,只有白名单内的IP才能使用该 API Key 作为接口调用时的身份凭证,白名单外请求被拒(HTTP 403)。如果您的设备是固定IP地址,设置这一项将有效降低因 API Key 泄露而被盗刷的风险。
留空时视作不设置访问IP白名单,允许所有IP访问
启用/停用
随时一键停用,不删除历史用量。