> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ariacompute.cn/llms.txt
> Use this file to discover all available pages before exploring further.

# 创建与列出 API 密钥

> 生成带有可选作用域的新 API 密钥，并列出已有密钥。原始密钥仅在创建时返回一次。

管理用于编程访问的 API 密钥。使用名称与可选作用域创建一个新密钥，然后列出所有已有密钥以查看其元数据。完整的密钥值仅在创建响应中可见。

## 创建 API 密钥

### 接口

```http theme={null}
POST /v1/api-keys
```

## 认证

传递 `Authorization: Bearer <api-key>` 或 `Authorization: ApiKey <key>` 之一。

## 请求体

<ParamField body="name" type="string" required>
  便于识别的密钥名称。
</ParamField>

<ParamField body="scopes" type="array">
  可选的权限作用域数组。
</ParamField>

### 响应

<ResponseField name="id" type="string">
  唯一的密钥标识符。
</ResponseField>

<ResponseField name="name" type="string">
  密钥名称。
</ResponseField>

<ResponseField name="key" type="string">
  原始 API 密钥。仅显示一次。
</ResponseField>

<RequestExample>
  ```bash cURL theme={null}
  curl -X POST https://agent.example.com/v1/api-keys \
    -H "Authorization: Bearer <api-key>" \
    -H "Content-Type: application/json" \
    -d '{
      "name": "production-worker",
      "scopes": ["agent:read", "agent:write"]
    }'
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "id": "key_01E",
    "name": "production-worker",
    "key": "aria_live_abc123xyz"
  }
  ```
</ResponseExample>

## 列出 API 密钥

### 接口

```http theme={null}
GET /v1/api-keys
```

### 响应

<ResponseField name="items" type="array">
  密钥元数据对象数组。
</ResponseField>

<ResponseField name="items[].id" type="string">
  密钥标识符。
</ResponseField>

<ResponseField name="items[].name" type="string">
  密钥名称。
</ResponseField>

<ResponseField name="items[].prefix" type="string">
  密钥的可见前缀。
</ResponseField>

<ResponseField name="items[].created_at" type="string">
  ISO 8601 创建时间戳。
</ResponseField>

<RequestExample>
  ```bash cURL theme={null}
  curl https://agent.example.com/v1/api-keys \
    -H "Authorization: Bearer <api-key>"
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "items": [
      {
        "id": "key_01E",
        "name": "production-worker",
        "prefix": "aria_li",
        "created_at": "2024-06-01T12:00:00Z"
      }
    ]
  }
  ```
</ResponseExample>