Skip to content

Get real-time backend startup sequence status

GET
/api/system/status/startup

Get real-time backend startup sequence status for frontend polling.

Provides current status of the backend’s startup sequence for frontend monitoring. This endpoint is polled by the SplashScreen component every 100-500ms to display accurate loading progress and handle startup failures gracefully. Returns the current initialization step, progress percentage, status message, and completion/failure flags from the centralized startup_status object.

Returns:

  • StartupStatusResponse: Startup status with the following fields:
    • current_step: Current initialization step description
    • progress: Progress percentage (0-100)
    • message: Detailed status message for current step
    • is_complete: Whether startup sequence is complete
    • has_failed: Whether startup encountered fatal error

Raises:

  • HTTPException(500): If startup status cannot be retrieved

Usage Pattern: Frontend components should poll this endpoint every 100-500ms during startup to display real-time progress. Check has_failed flag to detect startup failures and is_complete flag to transition to the main application interface.

Example Response:

{
    "currentStep": "Initializing AI Service",
    "progress": 75,
    "message": "Loading language models...",
    "isComplete": false,
    "hasFailed": false
}

Successful Response

StartupStatusResponse

Response model for the real-time startup status.

object
currentStep
required
Currentstep
string
progress
required
Progress
integer
message
required
Message
string
isComplete
required
Iscomplete
boolean
hasFailed
required
Hasfailed
boolean