更新时间:2026-06-10 GMT+08:00
分享

创建 API Key - CreateCoreSpaceApiKey

功能介绍

创建新的 API Key,用于数据面访问认证。

API Key 先于 Space 创建,创建后通过 CreateSpace 的 api_key_id 参数绑定到 Space。

调用方法

请参见如何调用API

URI

POST /v1/core/space-keys

请求参数

响应参数

状态码:201

表1 响应Body参数

参数

参数类型

描述

id

String

参数解释:

API Key ID,唯一标识一个 API Key,可通过"创建 API Key"接口获取。用于创建space时,指定入参api_key_id。

取值范围:

不涉及。

api_key

String

参数解释:

API Key 明文(仅创建时返回一次,请妥善保存)。用于调用数据面API时的接口认证,请求头如下:Authorization: Bearer ${api_key}。

取值范围:

不涉及。

状态码:400

表2 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码,标识错误类型,格式为 AgentArts.XXXXXXXX。

取值范围:

不涉及。

error_msg

String

参数解释:

错误信息,描述错误详情,供问题排查使用。

取值范围:

不涉及。

状态码:401

表3 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码,标识错误类型,格式为 AgentArts.XXXXXXXX。

取值范围:

不涉及。

error_msg

String

参数解释:

错误信息,描述错误详情,供问题排查使用。

取值范围:

不涉及。

状态码:403

表4 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码,标识错误类型,格式为 AgentArts.XXXXXXXX。

取值范围:

不涉及。

error_msg

String

参数解释:

错误信息,描述错误详情,供问题排查使用。

取值范围:

不涉及。

encoded_authorization_message

String

参数解释:

编码后的授权失败信息。

取值范围:

不涉及。

details

Array of CoreSpaceCommonError objects

参数解释:

依赖的下游服务错误信息列表,包含导致当前请求失败的下游服务错误详情。

取值范围:

不涉及。

表5 CoreSpaceCommonError

参数

参数类型

描述

error_code

String

参数解释:

错误码,标识错误类型,格式为 AgentArts.XXXXXXXX。

取值范围:

不涉及。

error_msg

String

参数解释:

错误信息,描述错误详情,供问题排查使用。

取值范围:

不涉及。

状态码:429

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码,标识错误类型,格式为 AgentArts.XXXXXXXX。

取值范围:

不涉及。

error_msg

String

参数解释:

错误信息,描述错误详情,供问题排查使用。

取值范围:

不涉及。

状态码:500

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码,标识错误类型,格式为 AgentArts.XXXXXXXX。

取值范围:

不涉及。

error_msg

String

参数解释:

错误信息,描述错误详情,供问题排查使用。

取值范围:

不涉及。

请求示例

/v1/core/space-keys

响应示例

状态码:201

API Key 创建成功

{
  "id" : "f1dc7160-4b09-41c6-989c-27c6303ddcc4",
  "api_key" : "sk-xxxxxxxxxxxxxxxx"
}

状态码:400

请求参数错误

{
  "error_code" : "AgentArts.01010001",
  "error_msg" : "Invalid request parameter format"
}

状态码:401

认证失败

{
  "error_code" : "AgentArts.01020002",
  "error_msg" : "Authentication failed"
}

状态码:403

权限不足

{
  "error_code" : "AgentArts.01010002",
  "error_msg" : "Insufficient permissions"
}

状态码:429

请求过于频繁

{
  "error_code" : "AgentArts.01020008",
  "error_msg" : "Too many requests"
}

状态码:500

内部服务错误

{
  "error_code" : "AgentArts.01010008",
  "error_msg" : "Internal service error"
}

状态码

状态码

描述

201

API Key 创建成功

400

请求参数错误

401

认证失败

403

权限不足

429

请求过于频繁

500

内部服务错误

错误码

请参见错误码

相关文档