Sign in

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

Changes

Changed in 2 of the 6 revisions of this API.121

  • f728bfcee69312See the full diff
    • ●

      added the new bounded_by_requested_limit enum value to the enumeration_scope response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new cancelled enum value to the background_state response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new complete enum value to the state response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new completed enum value to the background_state response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new exhausted enum value to the enumeration_scope response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new failed enum value to the background_state response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new generating enum value to the state response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new indeterminate enum value to the enumeration_scope response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new initializing enum value to the state response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new not_started enum value to the background_state response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new ready enum value to the state response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new running enum value to the background_state response property for the response status 200

      response-property-enum-value-added

  • 56f0e753f2e41See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog