获取 Keys

开发环境

http://dev-cn.your-api-server.com

GET

/v1/projects/{project_id}/keys

密钥与Deepgram项目关联。它们使您能够使用Deepgram API, 识别调用API的项目，并将使用信息与项目关联。密钥被分配了权限范围，这决定了它们可以在关联项目中执行哪些操作。对于每个项目，您可以创建多个密钥，并为每个密钥分配不同的权限范围。

如果经过认证的帐户有权限访问members:read、admins:read和owners:read项目范围，它将列出项目的所有密钥。否则，它只会列出属于认证帐户的密钥。

需要的账户/项目范围：keys:read。可选的项目范围：members:read、admins:read、owners:read。

所需的Deepgram本地产品范围：onprem:product:api和onprem:product:engine。

阅读更多关于角色和权限范围的信息。

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://dev-cn.your-api-server.com/v1/projects//keys'

响应示例

200 - 成功示例

{
  "api_keys": [
    {
      "member": {
        "member_id": "c74f9a10-ea40-4585-951e-88e63c35108f",
        "email": "devrel@deepgram.com",
        "first_name": "Deepgram",
        "last_name": "Team"
      },
      "api_key": {
        "api_key_id": "17c8886a-b58f-4c15-a7eb-9e52f2cf26ce",
        "comment": "Member API key",
        "scopes": [
          "member"
        ],
        "tags": [
          "user"
        ],
        "created": "2021-06-01T14:03:35.815832Z"
      }
    },
    {
      "member": {
        "member_id": "b74f9a00-ea40-4585-951e-88e63c35108f",
        "email": "devrel@deepgram.com",
        "first_name": "Scott",
        "last_name": "Stephenson"
      },
      "api_key": {
        "api_key_id": "15f6022a-d188-4317-a3dd-4340fdeddb75",
        "comment": "Management API key",
        "scopes": [
          "owner"
        ],
        "created": "2021-05-30T12:24:33.564224Z"
      }
    }
  ]
}

请求参数

Path 参数

project_id

string

必需

您想要获取密钥的项目的唯一标识符。（通用唯一标识）

返回响应

🟢200成功

application/json

Body

api_keys

array [object {2}]

必需

member

object

必需

api_key

object

必需

🟠403禁止访问

🟠404记录不存在

删除项目

获取 Key