创建项目 API 密钥

POST

/v1/api-keys

创建一个仅属于当前租户和项目的 API 密钥。完整明文只在本次响应中展示一次，请立即安全保存。

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Body 参数application/json必填

示例

{
    "name": "ERP 生产调用",
    "scopes": [
        "thread:create",
        "turn:create",
        "usage:read"
    ],
    "expiresAt": "2027-01-01T00:00:00.000Z"
}

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location '/v1/api-keys' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "name": "ERP 生产调用",
    "scopes": [
        "thread:create",
        "turn:create",
        "usage:read"
    ],
    "expiresAt": "2027-01-01T00:00:00.000Z"
}'

返回响应

🟢201

application/json

密钥创建成功，明文只展示一次。

Bodyapplication/json

示例

{
    "id": "key_0123456789abcdef0123456789abcdef",
    "name": "ERP 生产调用",
    "keyPrefix": "ys_live_key_0123456789abcdef0123456789abcdef.",
    "scopes": [
        "thread:create",
        "turn:create",
        "usage:read"
    ],
    "status": "active",
    "expiresAt": "2027-01-01T00:00:00.000Z",
    "createdAt": "2026-09-27T03:00:00.000Z",
    "apiKey": "ys_live_key_0123456789abcdef0123456789abcdef.AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
}

🟠400BadRequest

🟠401Unauthorized

🟠403Forbidden

🔴500InternalError

修改于 2026-09-27 15:11:45

流式接收产品事件

分页查询项目 API 密钥