创建 API Key

支持组织拥有者为组织内的 Agent 或 Workflow 创建 API Key。

可以通过该接口为指定的 Agent 或 Workflow 签发新的 API Key，并设置该 Key 是否具备版本管理权限。创建成功后，可使用返回的 API Key 调用该 Agent 或 Workflow 的资源级接口。

请求方式

POST

调用地址

https://api.${endpoint}/v1/org/api-key/create

调用验证

使用账号级 DevKey / DevSecret 的 Basic 鉴权，并要求调用账号为该组织的拥有者。

请求

请求示例

curl -X POST 'https://api.${endpoint}/v1/org/api-key/create' \ -H 'Authorization: Basic ${BASIC_TOKEN}' \ -H 'Content-Type: application/json' \ -d '{ "org_id": "p-xxxx", "agent_id": "68d0f1a2b3c4d5e6f7a8b9c0", "is_publish": true }'

                      
                      curl -X POST 'https://api.${endpoint}/v1/org/api-key/create' \
  -H 'Authorization: Basic ${BASIC_TOKEN}' \
  -H 'Content-Type: application/json' \
  -d '{
    "org_id": "p-xxxx",
    "agent_id": "68d0f1a2b3c4d5e6f7a8b9c0",
    "is_publish": true
  }'

此代码块在浮窗中显示

请求头

字段	类型	说明
Authorization	Basic ${BASIC_TOKEN}	使用 `DevKey:DevSecret` Base64 后的 Basic Token。
Content-Type	application/json	请求体格式。

请求参数（Body Parameters）

参数	类型	说明	required
org_id	String	组织 ID，可通过查询组织列表接口获取。	true
agent_id	String	需要创建 API Key 的 Agent ID。与 `workflow_id` 二选一，且只能传其中一个。	false
workflow_id	String	需要创建 API Key 的 Workflow ID。与 `agent_id` 二选一，且只能传其中一个。	false
is_publish	Boolean	是否为该 API Key 开启版本管理权限（导入、版本列表、发布、回滚）。仅设置权限，不会触发发布。必须传 JSON 布尔值 `true` 或 `false`，不支持 `"true"`、`1` 等写法。	true

说明：

agent_id 与 workflow_id 必须且只能传一个非空值；两者都传、都不传或传入空白字符串时，返回参数错误。
传入的 ID 必须与资源类型一致：通过 agent_id 传入 Workflow ID，或通过 workflow_id 传入 Agent ID，会返回类型不匹配错误。
每个 Agent 或 Workflow 最多拥有 10 个 API Key，达到上限后需先删除已有 Key 再创建。
新建的 API Key 名称由系统自动生成，格式为 api- 加 12 位随机字符，可在控制台的 API 密钥页面查看或修改。
该接口按账号限流，每个账号每分钟最多调用 10 次。

响应

响应示例

{ "code": 0, "message": "OK", "data": { "api_key": "app-xxxxxxxxxxxxxxxxxxxxxxxx" } }

                      
                      {
  "code": 0,
  "message": "OK",
  "data": {
    "api_key": "app-xxxxxxxxxxxxxxxxxxxxxxxx"
  }
}

此代码块在浮窗中显示

成功响应

字段	类型	说明
api_key	String	新创建的 API Key，用于调用对应 Agent 或 Workflow 的资源级接口。

请妥善保管返回的 API Key。该接口响应头包含 Cache-Control: no-store，请勿在日志或缓存中留存明文 Key。

失败响应

字段	类型	说明
code	Integer	错误码。
message	String	错误详情。

错误码

错误码	说明
40000	参数错误，如缺少必填参数、`is_publish` 不是布尔值、`agent_id` 与 `workflow_id` 未满足二选一，或该资源的 API Key 数量已达上限。
40101	请求头 `Authorization` 为空。
40104	当前账号不是该组织的拥有者。
40324	DevKey 或 DevSecret 错误。
40348	Agent 或 Workflow 不存在，或不属于该组织。
403204	传入的 ID 与资源类型不匹配（Agent / Workflow）。

状态码

状态码	说明
200	成功
400	参数错误
401	未授权
403	权限不足
429	请求过于频繁
500	服务器错误