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

# 渠道列表与详情

```bash curl theme={"theme":{"light":"min-light","dark":"min-dark"}}
curl "https://sys.poixe.com/api/channels?page=1&page_size=20&status=enabled" \
  -H "Authorization: Bearer $POIXE_SYSTEM_TOKEN"
```

```json response theme={"theme":{"light":"min-light","dark":"min-dark"}}
{
  "total": 3,
  "page": 1,
  "page_size": 20,
  "items": [
    {
      "id": 1,
      "name": "my-channel",
      "comment": "primary key",
      "status": "enabled",
      "type": "openai_chatgpt",
      "type_name": "OpenAI ChatGPT",
      "base_url": "https://api.openai.com",
      "key_mask": "sk-...abcd",
      "price": 1.0,
      "usage": {
        "used_quota": 10.000,
        "request_count": 500
      }
    },
    {
      "id": 2,
      "name": "disabled-channel",
      "comment": "",
      "status": "system_disabled",
      "type": "deepseek_deepseek",
      "type_name": "DeepSeek DeepSeek",
      "base_url": "https://api.deepseek.com",
      "key_mask": "sk-...efgh",
      "price": 0.5,
      "usage": {
        "used_quota": 50.000,
        "request_count": 2000
      },
      "auto_disabled": {
        "reason": "exceeded max consumption limit",
        "disabled_at": 1731000000
      }
    }
  ],
  "timestamp": 1731337200
}
```

GET
`https://sys.poixe.com/api/channels`

分页获取当前账户的渠道列表。

## 查询参数

**page** `integer` (default: 1)

页码（从 1 开始）

**page\_size** `integer` (default: 20)

每页条数，最大 100

**status** `string`

按状态过滤，可选值：`enabled` · `manual_disabled` · `system_disabled` · `archived`

## 响应字段

**total** `integer`

渠道总数

**page** `integer`

当前页码

**page\_size** `integer`

每页条数

**items** `array`

渠道列表，每项字段如下：

**渠道对象字段**

**id** `integer`

渠道 ID

**name** `string`

渠道名称

**comment** `string`

备注

**status** `string`

渠道状态：`enabled` · `manual_disabled` · `system_disabled` · `archived` · `unknown`

**type** `string`

渠道类型 slug，如 `openai_chatgpt`

**type\_name** `string`

渠道类型展示名称，如 `OpenAI ChatGPT`

**base\_url** `string`

上游 Base URL

**key\_mask** `string`

API Key 脱敏展示，格式如 `sk-...abcd`

**price** `number`

价格倍率

**usage** `object`

用量统计：

**usage 字段**

**used\_quota** `number`

上游额度消耗，单位 USD。按官方计费价格计算的上游实际调用消耗量

**request\_count** `integer`

累计请求次数

**auto\_disabled** `object`

系统自动禁用原因，仅当 `status` 为 `system_disabled` 时存在：

**auto\_disabled 字段**

**reason** `string`

禁用原因描述

**disabled\_at** `integer`

禁用时间戳（Unix 秒）

**timestamp** `integer`

响应时间戳（Unix 秒）

## 获取单个渠道详情

```bash curl theme={"theme":{"light":"min-light","dark":"min-dark"}}
curl https://sys.poixe.com/api/channels/1 \
  -H "Authorization: Bearer $POIXE_SYSTEM_TOKEN"
```

```json response theme={"theme":{"light":"min-light","dark":"min-dark"}}
{
  "id": 1,
  "name": "my-channel",
  "comment": "primary key",
  "status": "enabled",
  "type": "openai_chatgpt",
  "type_name": "OpenAI ChatGPT",
  "base_url": "https://api.openai.com",
  "key_mask": "sk-...abcd",
  "price": 1.0,
  "usage": {
    "used_quota": 10.000,
    "request_count": 500
  },
  "timestamp": 1731337200
}
```

GET
`https://sys.poixe.com/api/channels/:channelID`

获取单个渠道的详情。

## 路径参数

**channelID** `integer` *required*

渠道 ID

## 响应

返回单个渠道对象，字段与列表中的渠道对象相同，另附 `timestamp`。


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.