Channels

As the interactive spaces within Lux's station ecosystem, channels are where the multiplayer internet truly comes to life. Each channel exists within a station (like youtube.com, twitch.tv) and represents a specific location, room, or community space on that domain. Similar to Discord channels, Lux channels provide dedicated spaces for users to gather, interact, and engage with specific content together. This page details the various channel endpoints you can leverage to manage these spaces programmatically. We'll explore how to query, create, update, and delete channels within stations across the Lux environment.

The channel model

The channel model encompasses all essential information about a Lux channel, including its name, parent station, permissions, and member count. Channels serve as the actual planets and rooms where users gather within a station's domain. They maintain their own activity feeds, member lists, and configuration settings, enabling focused multiplayer interactions around specific pages or content. Whether users are watching videos together, discussing content, or playing mini-games, channels provide the structure needed for meaningful shared experiences within the broader station framework.

Properties

Name
id
Type
string
Description
Unique identifier for the channel.
Name
type
Type
number
Description
The type of channel.
Name
name
Type
string
Description
The customizable name of the channel.
Name
icon
Type
string
Description
The customizable icon of the channel.
Name
url
Type
string
Description
The unique url for the channel.
Name
total_messages_sent
Type
integer
Description
The total number of messages sent within this channel.
Name
flags
Type
integer
Description
The public flags for the channel.
Name
station_id
Type
string
Description
The station id which this channel belongs to.
Name
owner_id
Type
string
Description
The user id which this channel was created by.
Name
planet_id
Type
string
Description
The planet id which this channel owns.
Name
created_at
Type
timestamp
Description
Timestamp of when the channel was created.
Name
updated_at
Type
timestamp
Description
Timestamp of when the channel was last updated.

Channel types

Here is a list of the different channel types.

Name
station_channel
Description
A channel within a station. id = 0
Name
party_channel
Description
A party's channel. id = 1

GET/v1/channels/:channel_id

Get a channel

This endpoint allows you to retrieve a channel by providing its Lux id. Refer to the properties list at the top of this page to see which properties are included with channel objects.

Request

GET

/v1/channels/1344387816333352652

curl https://api.lux.gg/v1/channels/1344387816333352652 \
  -H "Authorization: {token}"

Response

{
  "id": "1344387816333352652",
  "type": 0,
  "name": "Lux Planet 31",
  "icon": "https://cdn.lux.gg/icons/1344387816333352652/1344271785771798589.png",
  "url": "https://lux.gg/nexus?w=ksdjyUYh",
  "total_messages_sent": 714,
  "station_id": "1097133765354061945",
  "planet_id": "1344271785771798589",
  "flags": null,
  "created_at": 2025-02-26 19:17:12.848375,
  "updated_at": 2025-02-26 19:17:12.848375
}

POST/v1/channels

Create a channel

This endpoint allows you to create a new channel.

Required attributes

Name
type
Type
number
Description
The type of channel.
Name
url
Type
string
Description
Unique identifier for the channel.

Optional attributes

Name
station_id
Type
string
Description
The station the channel belongs to.

Request

POST

/v1/channels

curl https://api.lux.gg/v1/channels \
  -H "Authorization: {token}" \
  -d url="https://lux.gg/nexus?w=ksdjyUYh" \
  -d station_id="1097133765354061945"

Response

{
  "id": "1344387816333352652",
  "type": 0,
  "name": "Lux Planet 31",
  "icon": null,
  "url": "https://lux.gg/nexus?w=ksdjyUYh",
  "total_messages_sent": 0,
  "flags": null,
  "station_id": "1097133765354061945",
  "planet_id": "1344271785771798589",
  "created_at": 2025-02-26 19:17:12.848375,
  "updated_at": 2025-02-26 19:17:12.848375
}