Channel List & Get

curl "https://sys.poixe.com/api/channels?page=1&page_size=20&status=enabled" \
  -H "Authorization: Bearer $POIXE_SYSTEM_TOKEN"

{
  "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
}

curl "https://sys.poixe.com/api/channels?page=1&page_size=20&status=enabled" \
  -H "Authorization: Bearer $POIXE_SYSTEM_TOKEN"

{
  "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
}

curl "https://sys.poixe.com/api/channels?page=1&page_size=20&status=enabled" \
  -H "Authorization: Bearer $POIXE_SYSTEM_TOKEN"

{
  "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

integer

default:"1"

Page number (1-indexed)

integer

default:"20"

Items per page, max 100

string

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

Response Fields

integer

Total number of channels

integer

Current page number

integer

Items per page

array

Channel list. Each item contains:

Show Channel object fields

integer

Channel ID

string

Channel name

string

Comment / note

string

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

string

Channel type slug, e.g. openai_chatgpt

string

Channel type display name, e.g. OpenAI ChatGPT

string

Upstream base URL

string

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

number

Price multiplier

object

Usage statistics:

Show usage fields

number

Upstream quota consumed in USD, measured at official list prices

integer

Cumulative number of requests

object

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

Show auto_disabled fields

string

Reason for auto-disabling

integer

Timestamp when auto-disabled (Unix seconds)

integer

Response timestamp (Unix seconds)

Get Single Channel

curl https://sys.poixe.com/api/channels/1 \
  -H "Authorization: Bearer $POIXE_SYSTEM_TOKEN"

{
  "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

integer

required

Channel ID

Response

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

API Reference

Text APIs

Extension APIs

System APIs

Query Parameters

Response Fields

Get Single Channel

Path Parameters

Response