> ## 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.

# Channel List & Get

```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`

Retrieve a paginated list of channels for the current account.

## Query Parameters

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

Page number (1-indexed)

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

Items per page, max 100

**status** `string`

Filter by status. Valid values: `enabled` · `manual_disabled` · `system_disabled` · `archived`

## Response Fields

**total** `integer`

Total number of channels

**page** `integer`

Current page number

**page\_size** `integer`

Items per page

**items** `array`

Channel list. Each item contains:

**Channel object fields**

**id** `integer`

Channel ID

**name** `string`

Channel name

**comment** `string`

Comment / note

**status** `string`

Channel status: `enabled` · `manual_disabled` · `system_disabled` · `archived` · `unknown`

**type** `string`

Channel type slug, e.g. `openai_chatgpt`

**type\_name** `string`

Channel type display name, e.g. `OpenAI ChatGPT`

**base\_url** `string`

Upstream base URL

**key\_mask** `string`

Masked API key, e.g. `sk-...abcd`

**price** `number`

Price multiplier

**usage** `object`

Usage statistics:

**usage fields**

**used\_quota** `number`

Upstream quota consumed in USD, measured at official list prices

**request\_count** `integer`

Cumulative number of requests

**auto\_disabled** `object`

System auto-disable details, present only when `status` is `system_disabled`:

**auto\_disabled fields**

**reason** `string`

Reason for auto-disabling

**disabled\_at** `integer`

Timestamp when auto-disabled (Unix seconds)

**timestamp** `integer`

Response timestamp (Unix seconds)

## Get Single Channel

```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`

Retrieve details for a single channel.

## Path Parameters

**channelID** `integer` *required*

Channel ID

## Response

Returns a single channel object with the same fields as a list item, plus `timestamp`.


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