创建 Key
POST
/v1/projects/{project_id}/keys在指定项目中创建新的密钥
您必须使用Deepgram控制台创建您的第一个API密钥。在拥有了您的第一个API密钥之后,您可以使用它为指定的项目创建更多密钥。
需要的账户/项目范围:keys:write
。
所需的Deepgram本地产品范围:onprem:product:api
和onprem:product:engine
。
请求参数
Path 参数
project_id
string
必需
您要为其创建密钥的项目的唯一标识符。(UUID)
Header 参数
content-type
string
必需
示例值:
application/json
Body 参数application/json
comment
string
必需
与您要创建的密钥关联的注释。长度必须介于 1 到 128 个字符之间,不包括空格。
scopes
string
必需
您想要创建的密钥的范围。
示例
{
"comment": "string",
"scopes": "string"
}
示例代码
返回响应
成功(200)
禁止访问(403)
记录不存在(404)
HTTP 状态码: 200
内容格式: JSONapplication/json
数据结构
api_key_id
string
必需
key
string
必需
comment
string
必需
scopes
array[string]
必需
created
string
必需
示例
成功示例
{
"api_key_id": "b6c318f0-bc94-40b3-83a9-7f6898cd5500",
"key": "1bc4a5e63f8425c9fd102539739923204243b9ce",
"comment": "Test On-prem API Key with curl",
"scopes": [
"member",
"onprem:product:api",
"onprem:product:engine",
"onprem:product:license-proxy"
],
"created": "2023-06-27T16:59:46.572660Z"
}
最后修改时间: 8 个月前