Sign in

v5

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-211355122.6 KB

Get Schedule Status

Report live generation state, API safeguards, and terminal reason for a session.

Args: schedule_id: Unique identifier of the session to inspect.

Returns: A non-blocking operational snapshot including initialization/background states, idle age, counts, completion metadata, and configured limits.

Raises: HTTPException: Status 404 when the session does not exist.

Behavior: State is derived from futures, tasks, exhaustion, and retained counts without invoking the solver or generator. The query refreshes the session access timestamp before the response is built, so reported idle time is near zero.

get/schedules/{schedule_id}/status

Path parameters

schedule_idstring required

Response

Successful Response

schedule_idstring required
state'initializing' | 'generating' | 'complete' | 'ready' required
background_state'not_started' | 'running' | 'cancelled' | 'failed' | 'completed' required
background_errorstring nullable required
completion_reasonstring nullable required
generated_schedulesinteger required
requested_schedule_limitinteger required
enumeration_scope'exhausted' | 'bounded_by_requested_limit' | 'indeterminate' required
known_distinct_schedulesinteger required
idle_secondsinteger required
session_ttl_secondsinteger required
solver_timeout_msinteger required
max_coursesinteger required
max_candidate_slotsinteger required
max_schedules_per_sessioninteger required