Skip to content
Ishvana Ishvana Docs

Launch Ishvana

POST
/api/apps/ishvana/request-open

Launch Ishvana dashboard application via start-ishvana.bat.

Executes the Ishvana application launcher batch file to start the Ishvana dashboard with all required services and orchestration. Designed for system tray integration and frontend launcher UI buttons.

Parameters:

  • request: Optional request payload (currently unused, reserved for future extensibility)

Returns:

  • LauncherResponse: Launch result with the following fields:
    • status: Launch status (“success” if batch file found and executed)
    • message: Human-readable status message
    • app: Application identifier (“ishvana”)

Raises:

  • HTTPException (500): If batch file not found or launch fails

Process:

  1. Validates batch file exists in project root
  2. Executes start-ishvana.bat via async subprocess
  3. Returns success response with launch confirmation

Example Request:

POST /api/frontend/request-open
{}

Example Response:

{
    "status": "success",
    "message": "Ishvana launching via start-ishvana.bat",
    "app": "ishvana"
}

Request Body

Section titled “Request Body ”
Any of:
LauncherRequest

Request model for app launcher endpoints.

Provides standardized request structure for application launch operations. Currently minimal to support future extensibility for launch options, environment variables, or launch parameters. Used by system tray integration and launcher API endpoints for consistent request handling.

Fields: Currently empty - reserved for future extensibility (launch options, environment variables, launch parameters, etc.)

Usage: POST /api/frontend/request-open uses this request model. POST /api/frontend/request-open uses this request model. POST /api/frontend/request-open uses this request model.

Example Request:

POST /api/frontend/request-open
{}

Future Extensibility: This model can be extended with fields such as:

  • options: Launch options dictionary
  • environment: Environment variables for launch
  • parameters: Additional launch parameters
  • timeout: Launch timeout in seconds
object

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

LauncherResponse

Response model for app launcher endpoints.

Provides standardized response structure for application launch operations including launch status, app identifier, and success message. Used by system tray integration and launcher API endpoints to report launch results.

Fields:

  • status: Launch operation status (“success”, “failed”)
  • message: Human-readable status message describing launch result
  • app: Application identifier (lowercase: “ishvana”, “mime”)

Example:

{
    "status": "success",
    "message": "Ishvana launching via start-ishvana.bat",
    "app": "ishvana"
}

Used By:

  • POST /api/frontend/request-open endpoint
  • POST /api/frontend/request-open endpoint
  • POST /api/frontend/request-open endpoint
  • System tray integration for app launching
  • Frontend launcher UI components

Note: Uses IshvanaBaseModel for automatic camelCase JSON conversion. Model config allows extra fields for extensibility while maintaining core structure.

object
status
required
Status

Launch operation status

string
message
required
Message

Human-readable status message

string
app
required
App

Application identifier (lowercase)

string

422

Section titled “422 ”

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object