Applications

As the foundation for interacting with the Lux API, applications are central to our developer ecosystem. Each application represents a distinct integration that can interact with the Lux platform, similar to Discord developer applications. This page details the various application endpoints you can leverage to manage these integrations programmatically. We'll explore how to query, create, update, and delete applications within the Lux environment.

The application model

The application model encompasses all essential information about a Lux application, including its name, description, and authentication details. It maintains references to the owner and tracks creation and update timestamps. Applications serve as secure entry points for interacting with the Lux API, enabling developers to build integrations that enhance the Lux experience.

Properties

Name
id
Type
string
Description
Unique identifier for the application.
Name
name
Type
string
Description
The name of the application.
Name
description
Type
string
Description
A description of what the application does.
Name
icon
Type
string
Description
URL to the application's icon.
Name
public_key
Type
string
Description
The public key used for API authentication.
Name
owner_id
Type
string
Description
The ID of the user who owns this application.
Name
created_at
Type
timestamp
Description
Timestamp of when the application was created.
Name
updated_at
Type
timestamp
Description
Timestamp of when the application was last updated.

GET/v1/applications/:application_id

Get an application

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

Request

GET

/v1/applications/1344387816333352652

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

Response

{
  "id": "1344387816333352652",
  "name": "Lux Bot",
  "description": "A bot for managing Lux communities",
  "icon": "https://assets.lux.gg/icons/1344387816333352652.png",
  "public_key": "9607061ecf879096524c199c9382b084527cfd36bdbbe1be820f6ded924316a8",
  "owner_id": "1344387816333399999",
  "created_at": "2025-02-26T19:17:12.848375Z",
  "updated_at": "2025-02-26T19:17:12.848375Z"
}

POST/v1/applications

Create an application

This endpoint allows you to create a new application.

Required attributes

Name
name
Type
string
Description
The name of your application.

Optional attributes

Name
description
Type
string
Description
A description of what your application does.
Name
icon
Type
string
Description
URL to your application's icon.

Request

POST

/v1/applications

curl https://api.lux.gg/v1/applications \
  -H "Authorization: {token}" \
  -d name="My Awesome App" \
  -d description="An application that integrates with Lux"

Response

{
  "id": "1344387816333352652",
  "name": "My Awesome App",
  "description": "An application that integrates with Lux",
  "icon": null,
  "public_key": "lux_pk_fj39f93jf93jf93jf93jf93jf93jf93j",
  "owner_id": "1344387816333399999",
  "created_at": "2025-02-26T19:17:12.848375Z",
  "updated_at": "2025-02-26T19:17:12.848375Z"
}