HTTP API (scripts & AI agents)
Everything the dashboard does goes through this JSON API on the local web port, so anything else can drive Starship the same way: a shell script, a notebook, a home-automation box, or an AI agent. This page is generated from the server's route table at release time, so it lists the routes of this build.
Basics
- Base URL:
http://127.0.0.1:8765by default ([web] host/port). To reach
it from another machine set [web] host = "0.0.0.0" and restart; keep the port off the public internet.
- Format: JSON in, JSON out. Every reply carries
"ok": true|falseand, on
failure, an "error" string. Send Content-Type: application/json.
- Authentication: off by default.
[web] auth_enabled = trueturns on HTTP
Basic Auth for every route except /api/version, /api/help and the login page.
- Activation: none in the free public edition.
- Jobs: long actions (capture, slew, autofocus, plate solve, flats) return a
job_id immediately. Poll GET /api/console/jobs (or /api/console/jobs/<id>) until the job is succeeded, failed or cancelled; a capture's result carries fits_path and rel_path, and rel_path is what the frame routes take.
- Plans: a sequence plan is TOML (see Plan format). The flow is
POST /api/sequencer/plans/validate -> POST /api/sequencer/plans/save -> POST /api/sequencer/start -> poll GET /api/sequencer/state.
- Safety stays in Starship. The safety supervisor, the sequencer's make-safe
phases, the park and roof interlocks and the health monitor act regardless of who is calling. An agent cannot bypass them and should not try; it reads state and asks for actions, and the rig says no when it must.
Playbook for an automation agent
What worked on real nights, in order:
GET /api/version,GET /api/state,GET /api/health/status- know the build,
the safety verdict and the memory headroom before touching anything.
POST /api/equipment/connect_all, thenGET /api/ascomuntil every role you
need reports connected: true. PHD2 must be running for guided plans.
- Write the plan as TOML,
validate, thensavewith a dated id, thenstart.
Author the make-safe phases in the plan (on_error, on_suspend, on_end: close the cover, park) - that is what protects the rig when you are not looking.
- Poll
GET /api/sequencer/stateevery 15-30 s: watchcurrent_step, the tail of
the journal, error and outcome. Poll GET /api/health/status for memory and GET /api/phd2 for guiding. Read the log only for diagnosis.
- When a run ends, decide from
stateandoutcome:succeeded-> start the next
plan; failed / stopped -> read the journal, fix, retry. Never start a plan on a mount that a safety layer just parked without understanding why.
- At the end: verify
at_parkand the cover on/api/ascom, then, if your site
has one, POST /api/console/roof_close.
Things an agent should not do: analyse full-resolution frames on a small PC while a capture is downloading (before v22.2.3 that alone could trip the memory floor), issue mount commands while a job is moving the mount, or change config.toml on an operator's rig without being asked.
Routes
GET routes read; POST routes act. Body keys are listed where the handler reads them; a key in brackets is optional. Routes are grouped by area.
alerts
- GET
/api/alerts/config- Alert channels and their settings (secrets redacted). - POST
/api/alerts/configBody:smtp_password. - GET
/api/alerts/history- Alerts sent tonight. - POST
/api/alerts/test
allsky
- GET
/api/allsky- All-sky camera state. - GET
/api/allsky/snapshot.jpg- The latest all-sky image. - POST
/api/allsky/testBody:url,allow_insecure_tls.
alpaca
- GET
/api/alpaca- The Alpaca slots, same shape as/api/ascom. - POST
/api/alpaca/...Body:channel,host,port,device_type,device_number,device_name. - POST
/api/alpaca/discover- Find Alpaca devices. With nohost, searches the network the way NINA does: the Alpaca discovery probe goes to UDP portdiscovery_port(default 32227) on every broadcast address and on 127.0.0.1, replies are collected fortimeout_s(default 2, 0.5 to 10), then every server's management API is read. Reply:servers, each withhost,port,server_name,manufacturer,version,location,devices(name,type,number,unique) anderror;probed;local_addresses(this PC's own IPv4 addresses; a server on this PC is listed under 127.0.0.1);duration_s; andtransport_enabled, false while the Alpaca transport is off, in which case nothing found can be connected until it is turned on and Starship restarted. With{"host": ..., "port": ...}, lists that one server'sdevices(needs the Alpaca transport on).
ascom
- GET
/api/ascom- The ASCOM slots: for each role the ProgID,connected, and the liveproperties(mount RA/Dec/sidereal time/side_of_pier/at_park/tracking, camera temperatures, focuser position, filter names, cover_state, shutter_status). - POST
/api/ascom/...Body:channel.
audit
- GET
/api/audit/log- The hash-chained audit log (paged): every command, verdict and event with its result. - GET
/api/audit/recent- The most recent audit events - the quickest way to see what just happened. - GET
/api/audit/verify- Re-verify the audit chain and report whether it is intact.
blockscript
- POST
/api/blockscript/dry_run- Walk a blockscript without touching anything:{"blockscript": {...}}(an editor draft) or{"name": "<saved>"}. The reply lists, list by list, what each action would do and what is wrong (an unknown action, a missing plan or saved schedule, a device role that is not configured).findingsrepeats every problem and warning in plain words with aseverity:problem,safety(unsafe / emergency / shutdown neither parks nor closes; an ordinarywarningwhen safety is in manual mode) orwarning;countsandseveritysummarise them. Nothing in the reply blocks a start. - POST
/api/blockscript/force_emergency- Force the EMERGENCY path now (make safe immediately). Also ends a run-again-every-night session for good. - POST
/api/blockscript/force_shutdown- Force the SHUTDOWN path now (orderly end of night). Also ends a run-again-every-night session for good. - POST
/api/blockscript/hold_resume- Hold ({"held": true}) or release the running blockscript. - POST
/api/blockscript/start- Start a saved blockscript:{"name": "..."}. Refused withrestart_risk: true,can_confirm: truewhile Windows has a restart pending; post again with"confirm_restart_risk": trueto start anyway. - GET
/api/blockscript/status- The night automation state machine: state, current block, held flag, last transition,end_causeonce it shuts down; for a run-again-every-night session alsorepeat_nightly,night(1, 2, ...) andrepeat_pending.
cctv
- GET
/api/cctv- CCTV sources. - GET
/api/cctv/snapshot/... - POST
/api/cctv/testBody:name.
config
- GET
/api/config- The effective configuration (secrets redacted). - POST
/api/config- Save settings: the full config document; the reply says whether a restart is needed and which keys. - POST
/api/config/reset- Reset the configuration to defaults (confirmrequired). - POST
/api/config/restart- Restart the service to apply startup-only settings. - POST
/api/config/restore_backup- Restore the previous config.toml backup.
console
- POST
/api/console/autofocus/adaptive-first-light- The older name of/api/console/autofocus/first-light(job). - POST
/api/console/autofocus/approve-focuser-report- Approve a measured backlash characterisation so it travels with the equipment profile. - GET
/api/console/autofocus/calibration- The learned focus position, the recipe andfirst_light: whether this focuser has its refocus formula (statusok / missing / legacy / stale) and its slope, backlash and validation. - POST
/api/console/autofocus/clear- Forget the learned calibration and First Light's formula (kept as focus_recipe.json.bak); First Light has to run again. - POST
/api/console/autofocus/first-light- First Light, run once when a focuser is set up: measures the V's slope and the focuser's backlash, checks them with two refocuses and saves the refocus formula; leaves the scope focused (job).{"channel": "follower"}does it for the follower train's focuser (defaultlead). - POST
/api/console/autofocus/focus-star- Slew to a suitable focus star:mag_min,mag_max,alt_min_deg,max_dist_deg(moves the mount). - POST
/api/console/autofocus/focus-wizard- The wizard with explicitcoarse_out/step(job). - POST
/api/console/autofocus/goto-focus- Move the focuser to the last learned focus position. - POST
/api/console/autofocus/linear- A plain linear sweep:start_offset,step,max_points(job). - POST
/api/console/autofocus/refocus- Refocus around the current position (job): with First Light's formula, a sweep of +/-refocus_range_factorx the star size / the V's slope; without it the older recipe sweep, and the result saysfirst_light_needed. Optionalfilter. - POST
/api/console/autofocus/run- Run the configured autofocus routine (job). - POST
/api/console/autofocus/wizard- Calibration sweep from a roughly focused start (resolutionoptional) (job). - POST
/api/console/calibration- Calibration frames job (v22.2.13): the body overrides single [calibration] values for this run, e.g. {"darks_count": 10, "dark_exposures_s": [60, 120], "target_temp_c": 5, "gain": null}. - POST
/api/console/capture- One exposure as a background job:exposure_s,light,binning,gain,offset,object_name,filter_name,frame_type. Returnsdetail.job_id; poll/api/console/jobsuntil the job issucceededand readresult.rel_path. - POST
/api/console/capture_abort- Abort a running capture:job_id. - POST
/api/console/center_here- Re-point so the clicked position of a solved frame is centred:rel_pathplus the click. - GET
/api/console/cooler- Cooler state: temperature, setpoint, power, settle state. - POST
/api/console/cooler_ramp- Cool slowly:target_coverminutes. - POST
/api/console/cooler_ramp_cancel- Cancel a ramp. - POST
/api/console/cooler_set_power- Cooler on/off:{"on": true|false}. Switching it on starts the same background cooler check as cooler_set_target (detail.cooler_check_job). - POST
/api/console/cooler_set_target-{"temp_c": -10}sets the camera setpoint live, then checks in the background that the cooler really cools (a cooler that reads on at 0 % is switched off and on once); the job id isdetail.cooler_check_job.{"check": false}skips the check. - POST
/api/console/cooler_warm_up- Warm the sensor up gently totarget_c. - POST
/api/console/dome/abort- Stop dome motion. - POST
/api/console/dome/gohome- Go home: rotate to the remembered home azimuth (or[observatory] dome_home_azimuth_deg) without the sensor search; refused until a home azimuth is known. - POST
/api/console/dome/goto- Rotate the dome toazimuth. - POST
/api/console/dome/home- Find home: start the driver's home-sensor search (v22.2.10: returns at once with ajob_id; watchat_homein the status). Starship remembers the azimuth the dome reports AtHome at. - POST
/api/console/dome/park- Park the dome. - POST
/api/console/dome/slave- Slave the dome to the mount:{"on": true|false}. - GET
/api/console/dome/status- Dome/roof state: shutter, azimuth, slaving, at-home/at-park. - POST
/api/console/dome/sync- Record a sync point for the dome geometry solver at the current pointing. - POST
/api/console/dome/sync-clear- Delete all sync points. - POST
/api/console/dome/sync-delete- Delete one sync point:pier_side,index. - GET
/api/console/dome/sync-list- The recorded sync points. - GET
/api/console/filterwheel- Filter wheel position and names. - POST
/api/console/filterwheel_set_position- Move the wheel toposition(slot index). - GET
/api/console/flat- Auto Flat state and the per-filter plan. - POST
/api/console/flat/auto- Run the Auto Flat plan (job). - POST
/api/console/flat/sky- Twilight (sky) flats as a job:{"when": "dawn"|"dusk", "park_on_end"?: bool, "close_roof_on_end"?: bool}. Waits for the sun window ([flat] sky_sun_alt_*), opens the roof claim and the flat cover, slews to the flat spot with tracking off, shoots every [flat].filters row ordered by sky sensitivity and meters each saved frame. Returnsdetail.job_id; progress on/api/console/jobs/{id}and theflat.progressbus event; the job result has the Auto Flat shape plusorder,sun_alt_start,sun_alt_endand per-filteroff_target. - POST
/api/console/flat_calibrator- Flat panel:{"on": true, "brightness": 0-255}. - POST
/api/console/flat_cover-{"action": "open"|"close"}on the flat cover; readcover_stateback on/api/ascom(3 = open, 1 = closed). - POST
/api/console/focuser_diag- Focuser diagnostics (travel, backlash probe). - POST
/api/console/focuser_halt- Stop the focuser. - POST
/api/console/focuser_move- Move the focuser:position(absolute, orrelative: true). - POST
/api/console/follower_start- Start the piggyback follower train. - POST
/api/console/follower_stop- Stop the piggyback follower train. - POST
/api/console/frame_hfd- Star metrics on a saved frame:{"rel_path": "<file from a job result>"}->hfr_median,n_stars,eccentricity_median, background. - POST
/api/console/free_memory- Drop caches and run garbage collection now. - POST
/api/console/halt_all- Emergency stop: abort every motion and capture. - GET
/api/console/jobs- Background jobs (captures, slews, autofocus, plate solves): id, state (running / succeeded / failed / cancelled), progress,result(a capture'sfits_pathandrel_path), error. - GET
/api/console/jobs/... - POST
/api/console/jobs/...Body:answer. - GET
/api/console/jobs/<id>- One job: state, progress, result, error. - POST
/api/console/jobs/<id>/cancel- Cancel a running job (a capture is aborted, a slew stopped). - POST
/api/console/jobs/<id>/confirm- Answer a job that paused for a confirmation:{"answer": true|false}. - POST
/api/console/jog_heartbeat- Keep a jog alive (it stops itself when the heartbeat stops). - POST
/api/console/jog_start- Start a manual jog:direction,rate_fraction; keep it alive withjog_heartbeat. - POST
/api/console/jog_stop- Stop a jog. - GET
/api/console/last_frame- Metadata of the last captured frame and its preview. - POST
/api/console/mount_abort- Abort the current slew. - POST
/api/console/mount_find_home- Run the mount's find-home routine. - POST
/api/console/mount_home- Send the mount to its home position. - POST
/api/console/mount_park- Park and wait for the driver to report parked (the wait says why if it does not). - POST
/api/console/mount_set_tracking-{"on": true|false}. - POST
/api/console/mount_slew- Slew (ra_hours,dec_degrees, optionalsync,frame) as a job. - POST
/api/console/mount_unpark- Unpark. - POST
/api/console/plate_solve- Solve a saved frame:rel_path, optionalra_hint_hours/dec_hint_degrees,blind(job). - POST
/api/console/polar_align- Start the plate-solved polar alignment routine (job). - POST
/api/console/polar_align_stop- Stop it. - GET
/api/console/power- Power box switches and their states. - POST
/api/console/power_set- Switch a power channel:switch_id,on(confirm_offto cut power to a device that is in use). - POST
/api/console/precise_slew- Slew, solve, sync and re-slew until the target is centred:ra_hours,dec_degrees(job). - POST
/api/console/pulse_guide- A guide pulse:direction,duration_ms. - POST
/api/console/resolve_target- Resolve a name to coordinates:name. CDS Sesame first (https; a mirror whose certificate the PC cannot verify is retried over plain http), then the built-in OpenNGC catalogue when no mirror answers (sourcesays which,notesays why). The error names every mirror and its reason. - POST
/api/console/roof_close- Close the roof / shutter. Refused unless the mount is parked (orconfirm_unparkedis true). - POST
/api/console/roof_open- Open the roof / shutter (subject to the safety verdict). - POST
/api/console/rotate_to_pa- Rotate the field to a sky position angle:target_pa_deg(plate-solved). - GET
/api/console/rotator- Rotator position and state. - POST
/api/console/rotator_halt- Stop the rotator. - POST
/api/console/rotator_move- Move the rotator toposition_deg. - POST
/api/console/target_get_selected- Read the target selected in the planetarium. - POST
/api/console/target_send- Send a target to the planetarium:ra_hours,dec_degrees,object_name.
diagnostics
- GET
/api/diagnostics- The diagnostics ring buffer (recent log lines and events).
equipment
- POST
/api/equipment/connect_all- Connect every configured device on every transport, then PHD2 (launched here when[phd2] auto_startis on - never at Starship startup - and asked to connect its guide camera + mount). Returns per-role results and the cooling-on-connect state. - POST
/api/equipment/connect_done- Tell the cooling-on-connect window that a manual bring-up is finished. - POST
/api/equipment/connect_plan- The ordered bring-up plan (which roles connect in which order);bringupselects a saved plan. - POST
/api/equipment/disconnect_all- Disconnect every device on every transport - PHD2 first, when control is allowed: it stops guiding and disconnects its guide camera + mount (reported as aphd2/guiderresult; a PHD2 that is not running is skipped and never fails the call). - POST
/api/equipment/disconnect_plan- The ordered shutdown plan (the PHD2 guider step first when PHD2 is connected or Connect all armed it). - POST
/api/equipment/step- Connect or disconnect ONE role:{"transport": "ascom"|"alpaca", "role": "camera", "action": "connect"|"disconnect"}.{"transport": "phd2", "role": "guider"}runs the PHD2 step of Connect all (launch + connect its gear) or Disconnect all (stop guiding + disconnect its gear).
equipment profiles
- GET
/api/equipment_profiles- Saved equipment profiles. - POST
/api/equipment_profiles/applyBody:name. - POST
/api/equipment_profiles/deleteBody:name. - POST
/api/equipment_profiles/saveBody:name.
filters
- GET
/api/filters- The filter library.
fits
- GET
/api/fits- FITS module state: watched folder, last file, preview status. - GET
/api/fits/download/...- v23 A07: the raw FITS file, and the folders under the images folder. - GET
/api/fits/download/<rel_path>- The FITS file itself, as saved (a path inside the images folder). - GET
/api/fits/folders- The folders directly under?path=(inside the images folder; blank = the images folder), each with its FITS file count. List a folder's files withGET /api/fits/list?prefix=<path>/. - GET
/api/fits/header/... - GET
/api/fits/header/<rel_path>- The FITS header of a saved frame. - GET
/api/fits/list- FITS files under IMAGES, newest first (name,rel_path,size_bytes,mtime). v22.2.7:?limit=(default 100, max 5000),?offset=,?since=/?until=(unix seconds or ISO 8601, on the file mtime) and?prefix=(a rel_path / subfolder prefix such asNGC_300/orflats_L) let a client enumerate a whole night; the reply carriescount,limit,offset. v22.2.8: a listing withsince,untilorprefixalways looks into subfolders (flats_<filter>/, a capture's subfolder), whatever[fits] watch_recursivesays; the plain listing still follows that setting. - GET
/api/fits/preview/... - GET
/api/fits/preview/<rel_path>- A stretched preview image (PNG) of a saved frame. - GET
/api/fits/stats/...- v23 A06: the stretch the preview used (black / midtones / white). - GET
/api/fits/stats/<rel_path>- The stretch a preview is drawn with (stretch: black, midtones, white) and its size. Pass the same three as query values to/api/fits/preview/<rel_path>to redraw with another stretch.
framing
- POST
/api/framing/create_sequence- Turn a framed target or mosaic into a sequence plan (appends to the library). - GET
/api/framing/fov- The camera's field of view from the optics or the connected camera. - POST
/api/framing/to_scheduler- Turn a framed target or mosaic into scheduler goals.
guardian
- POST
/api/guardian/simulate- Inject a fault for a role (scenario) to exercise the ladder - test rigs only. - GET
/api/guardian/status- The self-heal ladder: attempts per device, current rung, cooldowns.
guiding
- POST
/api/guiding/dither- Dither now:{"amount_px": 5, "ra_only": false}, then wait for PHD2 to settle (in the background). Refused while a sequence runs. - POST
/api/guiding/start- Start guiding in PHD2 and wait for it to settle (in the background; pollGET /api/guiding/status). Optionalsettle_pixels,settle_time_s,settle_timeout_s. Needs[phd2] allow_control; refused while a sequence runs or the mount is parked. Never asks PHD2 for a calibration. - GET
/api/guiding/status- Guiding control state:allow_control, the last start / dither (op: running, ok, error) and the guider state. - POST
/api/guiding/stop- Stop guiding (PHD2 stops capturing). Needs[phd2] allow_control.
health
- POST
/api/health/dismiss_memory- Dismiss a SOFT memory countdown (attended testing). The HARD floor cannot be dismissed. - GET
/api/health/status- Health level (HEALTHY / DEGRADED / CRITICAL) with every check's detail (memory, disk, cpu, threads, heartbeats, devices) and the escalation counters.
help
- GET
/api/help- The help topic list for this edition. - GET
/api/help/... - GET
/api/help/<topic>- One help topic rendered to HTML.
license
- POST
/api/license/activate- The free public edition needs no licence and answers so. - POST
/api/license/refresh- The free public edition never contacts the licence server and answers so. - GET
/api/license/status- Licence status:free: truein the free public edition.
meridian
- GET
/api/meridian/effective- What happens at the meridian, in plain words (read-only):planfor a plan's meridian settings (?plan_mode=inherit|off|halt|flip&plan_minutes=N) andschedulerfor the scheduler's Meridian flip setting (?scheduler=inherit|auto|flip|halt|off, default the saved one). Each hasmode,minutesand atextsentence.
night report
- GET
/api/night_report- Tonight's tally: frames per target and filter, integration, rejects, autofocus runs, guiding RMS samples, alerts, suspends. - GET
/api/night_report/nights- The nights a report exists for, each with its number of frames, andlast_with_frames: the most recent night that has any.
pete
- POST
/api/pete/checkBody:kind,plan_id,toml,plan,blockscript,name.
phd2
- GET
/api/phd2- PHD2 state (guider.app_state, RMS total/RA/Dec, SNR, star_lost, settling, last event). - POST
/api/phd2/test- Try a PHD2 connection:host,port.
planetarium
- GET
/api/planetarium- Planetarium connection state.
platesolve
- GET
/api/platesolve- Plate-solver configuration and last-solve state. - POST
/api/platesolve/test- Check an ASTAP installation:{"astap_path": "..."}.
profiles
- GET
/api/profiles- Configuration profiles. - POST
/api/profiles/deleteBody:name. - POST
/api/profiles/loadBody:name. - POST
/api/profiles/saveBody:name.
scheduler
- POST
/api/scheduler/...Body:confirm_restart_risk,position_angle,name,ra_h,dec_deg,priority,min_alt_deg,completion_mode,template,goals,precise_point,id,project_id,filter,exposure_s,goal_count,binning,gain,doc,description,replace. - POST
/api/scheduler/goals/add- Add a goal (target + filter + frames) to a project:ra_h,dec_deg,position_angle, ... - POST
/api/scheduler/goals/delete- Delete a goal. - POST
/api/scheduler/goals/update- Update a goal. - GET
/api/scheduler/history- What the dispatcher did on past nights. - GET
/api/scheduler/projects- Projects with their goals and progress from the ledger. - POST
/api/scheduler/projects/add- Add a project:name,priority,min_alt_deg,completion_mode,template,goals. - POST
/api/scheduler/projects/delete- Delete a project. - POST
/api/scheduler/projects/update- Update a project's fields. - GET
/api/scheduler/schedules- Saved named schedules. - POST
/api/scheduler/schedules/delete- Delete a saved schedule. - POST
/api/scheduler/schedules/recall- Replace the current schedule with a saved one. - POST
/api/scheduler/schedules/save- Save the current projects/goals as a named schedule. - POST
/api/scheduler/simulate- Dry-run the schedule for tonight (or several nights): per-target timeline and skip reasons. - POST
/api/scheduler/start- Start the scheduler's dispatcher. Refused withrestart_risk: true,can_confirm: truewhile Windows has a restart pending; post again with{"confirm_restart_risk": true}to start anyway. - GET
/api/scheduler/status- Dispatcher state, the current target/goal and the readiness gates. - POST
/api/scheduler/stop- Stop the dispatcher (the running sequence finishes its step). - GET
/api/scheduler/target_preview- Plain-words readiness of each target now (rising, Moon too close, sets in N min). - GET
/api/scheduler/templates- Sequence templates a project can use. - POST
/api/scheduler/templates/get- One template's document.
sequencer
- GET
/api/sequencer- Sequencer module state and the plan library summary. - GET
/api/sequencer/checkpoints- Runs that can be resumed after a crash or restart. - POST
/api/sequencer/pause- Pause at the next step boundary; the plan's on_suspend phase runs.{"make_safe": false}leaves the rig as it is: on_suspend is not run, the hold still runs it at once if the weather turns UNSAFE and ends the run at the plan's end time, and the resume does not run on_resume (nothing was closed). - GET
/api/sequencer/plans- The plan library: id, filename, name, notes, step_count, modified. - GET
/api/sequencer/plans/... - POST
/api/sequencer/plans/... - GET
/api/sequencer/plans/<id>- The plan's TOML and metadata. - POST
/api/sequencer/plans/<id>/delete- Delete (soft) a plan from the library. - POST
/api/sequencer/plans/estimate- Estimated duration of a plan:{"toml": "..."}. - POST
/api/sequencer/plans/from_structured- Compile the structured editor's document into plan TOML. - POST
/api/sequencer/plans/save- Save a plan into the library:{"id": "my-plan", "toml": "..."}. - POST
/api/sequencer/plans/validate- Compile a plan without saving it:{"toml": "..."}->ok,step_count, the compiled steps andwarnings(valid but predictably wrong, e.g. a weather restart that would begin at the park position), or the validation error. - POST
/api/sequencer/prompt- Answer the running plan's pending question (a failed start-up step asks "Try again?"):{"answer": "retry"|"cancel"|"pass", "id": "<prompt id>"}. The question is in/api/sequencer/state. 409 when there is no such question or the answer is not one it offers. - POST
/api/sequencer/resume- Resume a manual pause (a weather suspend can only be resumed by the supervisor). - POST
/api/sequencer/resume_run- Resume an interrupted run from its checkpoint:{"plan_id": "..."}. The pending-restart refusal andconfirm_restart_riskwork as on/api/sequencer/start. - POST
/api/sequencer/start- Start a run from the library ({"plan_id": "my-plan"}) or from inline TOML ({"toml": "..."}). Returnsrun_id,plan_name,step_count. Refused while a run is active. A plan with an end time or a dawn gate is refused withrestart_risk: true,can_confirm: truewhile Windows has a restart pending; post again with"confirm_restart_risk": trueto start anyway. - GET
/api/sequencer/state- The running or last run:state(idle / running / paused / stopping / stopped / succeeded / failed), plan name, run id,current_step/total_steps,error,outcome(label, subs, targets) and the journal (every step event with timestamps). - POST
/api/sequencer/stop- Stop the active run. The plan's on_end phase runs (park / close cover if authored); the state goes stopping -> stopped.{"skip_end_phase": true}skips on_end and the camera warm-up and leaves the rig exactly as it is (switching to another plan mid-night) - journaled. - GET
/api/sequencer/templates- Saved sequence templates (settings minus targets). - POST
/api/sequencer/templates/delete- Delete a template byname. - POST
/api/sequencer/templates/load- Load a template byname. - POST
/api/sequencer/templates/save- Save a template:name,doc.
skyhunter
- GET
/api/skyhunter/...Query:maxmag,q,cat,limit,id,ra,dec,radius,minalt,hours,minel,visible. - GET
/api/skyhunter/catalog-status- Age of the asteroid, comet and satellite catalogues (age_days,stale,sourceuser / bundled),can_refresh, andrefresh: the running or last in-app refresh. - POST
/api/skyhunter/customBody:elements. - GET
/api/skyhunter/fieldQuery:ra,dec,radius. - GET
/api/skyhunter/objectQuery:id. - GET
/api/skyhunter/passesQuery:hours,minel,visible,id. - POST
/api/skyhunter/refresh- Download fresh asteroid, comet and satellite catalogues:{"kind": "all"|"asteroids"|"comets"|"satellites"}(default all). Returns at once (started); the download runs in the background and its outcome is therefreshobject of/api/skyhunter/catalog-status(running,result). A failed download leaves the catalogue in use untouched. - GET
/api/skyhunter/searchQuery:q,cat,limit. - GET
/api/skyhunter/tonightQuery:cat,minalt,limit.
solo
- GET
/api/solo/last - GET
/api/solo/sources
state
- GET
/api/state- One snapshot of everything: the safety verdict (safety.stateSAFE / WARNING / UNSAFE / UNKNOWN / DISABLED with reasons), the Solo sensor values, site, optics and module states.
system
- POST
/api/system/terminate- Shut the service down cleanly (devices disconnected first). Body must be{"confirm": "SHUTDOWN"}.
version
- GET
/api/version- Build, version, edition, product name, the Pro capability map andlicence_required(false in the free public edition). Always reachable, even before activation.
Notes
- A route that is not in this build answers 404; the page you are reading was generated from the same build.
- Every command lands in the audit log (
GET /api/audit/recent) with its result, so a night driven by an agent can be reviewed step by step.