Skip to main content

Get All Apps

Get all apps, including running state for authenticated users.

Endpoint

Headers

Query Parameters

Can also authenticate with API key:
  • apiKey: API key for allowed packages
  • packageName: Package name (must be in allowed list)
  • userId: User email

Response

Implementation

  • File: packages/cloud/src/routes/apps.routes.ts:336-478
  • Middleware: unifiedAuthMiddleware - Allows core token or API key auth
  • Service: Enhances apps with hardware compatibility and running state

Get Public Apps

Get all published apps without authentication requirements.

Endpoint

Headers

Response

Implementation

  • File: packages/cloud/src/routes/apps.routes.ts:483-509
  • Middleware: authWithOptionalSession - Works with or without auth
  • Service: Filters by hardware compatibility if user session exists

Search Apps

Search apps by name or description.

Endpoint

Query Parameters

Response

Implementation

  • File: packages/cloud/src/routes/apps.routes.ts:514-571
  • Service: Searches by name and description

Get Available Apps

Get apps marked as available, with organization profiles.

Endpoint

Query Parameters

Response

Implementation

  • File: packages/cloud/src/routes/apps.routes.ts:1418-1497
  • Service: Enhances with organization profiles

Get Installed Apps

Get apps installed by the current user.

Endpoint

Headers

Response

Implementation

  • File: packages/cloud/src/routes/apps.routes.ts:1273-1340
  • Enhancement: Includes installation date and hardware compatibility

Get App Details

Get detailed information about a specific app.

Endpoint

Parameters

Response

Implementation

  • File: packages/cloud/src/routes/apps.routes.ts:576-661
  • Service: Includes organization profile and uninstallable flag

Install App

Install an app for the current user.

Endpoint

Headers

Parameters

Response

Success (200):
Error (400/404):

Implementation

  • File: packages/cloud/src/routes/apps.routes.ts:1106-1195
  • Validation: Checks if app exists and not already installed
  • Service: Updates user’s installed apps list and broadcasts state

Uninstall App

Remove an app from user’s installed apps.

Endpoint

Headers

Parameters

Response

Success (200):
Error (400/404):

Implementation

  • File: packages/cloud/src/routes/apps.routes.ts:1200-1268
  • Service: Removes from user’s installed apps and stops running instance

Start App

Start an app session (alternative to voice command).

Endpoint

Headers

Parameters

Response

Success (200):
Error (404/500):

Implementation

  • File: packages/cloud/src/routes/apps.routes.ts:666-877
  • Middleware: unifiedAuthMiddleware - Requires active session
  • Service: Validates app exists, starts via AppManager, broadcasts state

Stop App

Stop a running app session.

Endpoint

Headers

Parameters

Response

Success (200):
Error (404/500):

Implementation

  • File: packages/cloud/src/routes/apps.routes.ts:882-1101
  • Service: Stops via AppManager, broadcasts state change

Get Cloud Version

Get the current cloud version.

Endpoint

Response

Implementation

  • File: packages/cloud/src/routes/apps.routes.ts:1518-1520
  • Note: Version is hardcoded in the source code

System Apps

The following apps are marked as non-uninstallable:
  • live.captions.augmentos
  • com.TeamopenSmartGlasses.SmartGlasses
  • cloud.mentra.mira
  • com.mentra.mira

Error Codes

Authentication Notes

The app endpoints support two authentication methods:
  1. Bearer Token: Standard JWT authentication in Authorization header
  2. API Key: For allowed packages (test.augmentos.mira, cloud.augmentos.mira, com.augmentos.mira) using query parameters:
    • apiKey: The API key
    • packageName: The package name
    • userId: User email
Device-specific operations (start/stop) require an active user session.