Skip to content
Ishvana Ishvana Docs

Get Engine Params

GET
/api/system/params

Get engine parameter registry for Operator Console.

Returns all exposed parameters with their metadata (type, min/max, description, etc.). This endpoint exposes the same data available in-process via instrument.get_params().

Returns: Dictionary mapping parameter names to parameter metadata:

  • name (str): Parameter name
  • param_type (str): Parameter type name (“str”, “int”, “float”, “bool”)
  • min (float | None): Minimum value (for numeric types)
  • max (float | None): Maximum value (for numeric types)
  • readonly (bool): Whether parameter is read-only
  • group (str): Parameter group/category
  • options (list[str] | None): Valid options (for enum types)
  • description (str): Human-readable description

Note: The getter and setter functions are not included in the response as they cannot be serialized. Use /api/system/params/{name}/value to get/set values.

Example Response:

{
  "params": {
    "orchestrator.state": {
      "name": "orchestrator.state",
      "paramType": "str",
      "readonly": true,
      "group": "Divine Agents",
      "description": "Current Boot Coordinator orchestrator state"
    },
    "etherforce.temperature": {
      "name": "etherforce.temperature",
      "paramType": "float",
      "min": 0.0,
      "max": 2.0,
      "readonly": false,
      "group": "Divine Agents",
      "description": "LLM temperature for text generation"
    }
  }
}

Raises:

  • HTTPException(503): If instrumentation layer is not available
  • HTTPException(500): If parameter retrieval fails

Use Cases:

  • Operator Console Configuration tab
  • Parameter discovery and documentation
  • Dynamic UI generation

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

InstrumentParamsResponse

Response model for engine parameter registry.

Provides all exposed parameters with their metadata (type, min/max, description, etc.). Used by instrument_routes for exposing instrumentation layer parameter registry to Operator Console.

Fields:

  • params: Dictionary mapping parameter names to parameter metadata (required, JsonDict)

Parameter Metadata Structure: Each parameter entry contains:

  • name: Parameter name (string)
  • param_type: Parameter type name (string: “str”, “int”, “float”, “bool”)
  • min: Minimum value for numeric types (float | None)
  • max: Maximum value for numeric types (float | None)
  • readonly: Whether parameter is read-only (bool)
  • group: Parameter group/category (string)
  • options: Valid options for enum types (list[str] | None)
  • description: Human-readable description (string)

Note: The getter and setter functions are not included in the response as they cannot be serialized. Use /api/system/params/{name}/value to get/set values.

Usage: GET /api/system/params returns this response model.

JSON Example:

{
  "params": {
    "orchestrator.state": {
      "name": "orchestrator.state",
      "paramType": "str",
      "readonly": true,
      "group": "Divine Agents",
      "description": "Current Boot Coordinator orchestrator state"
    },
    "etherforce.temperature": {
      "name": "etherforce.temperature",
      "paramType": "float",
      "min": 0.0,
      "max": 2.0,
      "readonly": false,
      "group": "Divine Agents",
      "description": "LLM temperature for text generation"
    }
  }
}
object
params
required
Params

Dictionary mapping parameter names to metadata

object
key
additional properties
object
key
additional properties
Any of:
string