Application Library
The application library tracks applications and branches owned by the current user, together with their installation state and live builds.
Library Application Object
A library application represents an application branch owned by the current user.
Library Application Structure
| Field | Type | Description |
|---|---|---|
| application | partial application object | The application |
| branch_id | snowflake | The ID of the application branch |
| branch? | application branch object | The application branch |
| entitlements? | array[entitlement object] | The entitlements granting access to the branch |
| flags | integer | The library application flags |
| created_at | ISO8601 timestamp | When the application was added to the library |
| sku | library SKU object | The SKU granting access to the application |
Library Application Flags
| Value | Name | Description |
|---|---|---|
| 1 << 0 | HIDDEN | The application is hidden from the library |
| 1 << 1 | PRIVATE | The application is private |
| 1 << 2 | OVERLAY_DISABLED | The legacy overlay is disabled for the application |
| 1 << 3 | ENTITLED | The user is entitled to the application |
| 1 << 4 | PREMIUM | The application is a premium application |
| 1 << 5 | OVERLAY_V3_DISABLED | Overlay V3 is disabled for the application |
Example Library Application
{ "application": { "id": "1481041280153819136", "name": "Orbital Foundry", "description": "Build an automated factory in orbit.", "icon": "38e66524a75e47a8a721f9dd7335602b", "type": 1, "flags": 0, "flags_new": "0", "verify_key": "9c4839f4cb2de22d3ffc73d93ae275154318a87fb1fbfa8a5ab36585f54a2d49", "hook": true, "is_verified": true, "is_discoverable": false, "is_monetized": false, "storefront_available": false }, "branch_id": "1481041754996117504", "entitlements": [], "flags": 8, "created_at": "2026-07-18T15:42:08.000000+00:00", "sku": { "id": "1481042148115515392", "type": 1, "premium": false, "preorder_release_at": null, "preorder_approximate_release_date": null }}Library SKU Structure
| Field | Type | Description |
|---|---|---|
| id | snowflake | The ID of the SKU |
| type | integer | The type of SKU |
| premium | boolean | Whether the SKU is a premium SKU |
| preorder_release_at | ?ISO8601 timestamp | When the preorder releases |
| preorder_approximate_release_date | ?string | The approximate preorder release date |
Application Branch Object
An application branch identifies a release channel and its current live build.
Application Branch Structure
| Field | Type | Description |
|---|---|---|
| id | snowflake | The ID of the branch |
| live_build_id? | snowflake | The ID of the branch's live build |
| name? | string | The name of the branch |
Application Build Object
An application build identifies the manifests needed to install a release.
Application Build Structure
| Field | Type | Description |
|---|---|---|
| id | snowflake | The ID of the build |
| manifests | array[application manifest object] | The build's manifests |
Application Manifest Structure
| Field | Type | Description |
|---|---|---|
| id | snowflake | The ID of the manifest |
Endpoints
List Owned Application Branches
GET/applications/{application.id}/branchesReturns a list of application branch objects for an application owned by the current user.
Get Library
GET/users/@me/libraryReturns a list of library application objects owned by the current user.
Modify Library Application Branch
PATCH/users/@me/library/{application.id}/{branch.id}Modifies a library application branch. Returns the updated library application object on success.
JSON Params
| Field | Type | Description |
|---|---|---|
| flags | integer | The library application flags |
Get Application Live Build
GET/applications/{application.id}/branches/{branch.id}/builds/liveReturns the live application build for the branch.
Query String Params
| Field | Type | Description |
|---|---|---|
| platform | string | The operating system and architecture to return a build for |
| locale | string | The locale to return a build for |
Get Application Build Size
POST/applications/{application.id}/branches/{branch.id}/builds/{build.id}/sizeCalculates the size of a build for the selected manifests.
JSON Params
| Field | Type | Description |
|---|---|---|
| manifest_ids | array[snowflake] | The IDs of the build manifests |
Response Body
| Field | Type | Description |
|---|---|---|
| size_kb | integer | The size of the build in kibibytes |
Get Application Branches
POST/branchesReturns a list of application branch objects. The client sends at most 50 branch IDs per request.
JSON Params
| Field | Type | Description |
|---|---|---|
| branch_ids | array[snowflake] | The IDs of the branches |