System API

System APIs can be called on an anonymous Command WS connection.

system.ping

Heartbeat probe.

Parameter	Type	Required	Notes
none	-	-	params can be an empty object.

Response data:

Field	Type	Notes
pong	boolean	Always true.

system.info

Returns a runtime status snapshot. Fields are supplied by the Runtime status_supplier.

Parameter	Type	Required	Notes
none	-	-	params can be an empty object.

Response data:

Field	Type	Notes
running	boolean	Whether the Runtime is running.
uptimeSec	number	Runtime uptime in seconds.
bindHost	string	Local service bind host.
process	object	Process information, including pid and executablePath.
http	object	HTTP service status, including enabled, sites, and assetBaseUrl.
ports	object	Local ports, including adminHttp, demoHttp, assetHttp, commandWs, and videoWs.
providers	object	Current provider names, including device, graphic, imageEnhance, ocr, ofd, and auth.
authDiagnostics	object	Auth-related environment configuration diagnostics.
ws	object	Command WS and Video WS connection, auth failure, request, or frame statistics.
application	object	Application session state, including boundSessions and activeStreams.

system.capabilities

Returns the auth model, public methods, and platform capabilities.

Parameter	Type	Required	Notes
none	-	-	params can be an empty object.

Response data:

Field	Type	Notes
auth_model.connection_requires_token	boolean	Whether Command WS handshake requires a token; currently false.
auth_model.session_field	string	Session field, currently session_token.
auth_model.session_binding	string	Currently connection_bound.
auth_model.video_binding	string	Currently session_token + stream_id.
methods[]	array	Method catalog; each item has method, requires_session, and summary.
platform_capabilities.sane	object	SANE supported platforms and provider information.
platform_capabilities.sane.supported_platforms	string[]	Currently ["linux"].
platform_capabilities.sane.linux_only	boolean	Currently true.
platform_capabilities.sane.provider	string	Current SANE provider name; empty string when unavailable.

Example:

{
  "request_id": "req-cap-001",
  "method": "system.capabilities",
  "params": {}
}