Agent Builder API

This page describes the context used by the in-app chart assistant and specialized Agent Builder profiles. It is not a separate public SDK.

Status boundary

The in-app chart snapshot is Current. Specialized-profile filtering is Preview. The global Local Desktop HTTP API is a separate Preview interface and is not scoped by an Agent Builder profile.

Active-Chart Snapshot

The chart assistant builds an AIAgentToolSnapshot from the active chart. The full internal type can evolve; integrations should use the JSON payload returned by the Local Desktop API instead of referencing desktop assemblies or view models.

The snapshot can contain:

Area	Representative fields
Chart	Symbol, TimeFrame, TotalCandleCount, VisibleCandleCount
Candles	Time, Open, High, Low, Close, Volume
Indicators	name, display/type name, plots, signals, selected parameter names and values, input metadata
Strategies	name, display/type name, enabled/state, account label, position count, selected parameters
Chart Trader	visibility/read-only/connection state, symbol, account label, order type, size, price, bid/ask, leverage, reduce-only, time-in-force, position, entry, PnL
Platform	active-window and open-window summaries, chart count, compile state
Research tools	Validator, Optimizer, strategy-tool, and Research Lab summaries where available

The context can include financially sensitive data even though it is not intended to include credentials. See AI Data and Privacy before using a cloud provider.

Parameter Filtering

The current script-parameter filter omits parameter names containing:

key
secret
password
token

This protects common cases but is not a general secret scanner. Do not place credentials, seed phrases, mnemonic phrases, wallet material, or private customer data in custom parameters or prompts.

Specialized-Profile Filtering

When a non-baseline specialized profile is selected in the supported in-app flow, HyperionX can filter:

• chart identity and counts
• candle data
• indicator and script context
• Chart Trader context
• strategy and research-tool context
• Code Lab/file prompt context

It can also block recognized in-app actions through read-only, order-routing, and market-order controls.

The filter does not currently enforce numeric or list-based risk fields such as daily loss, maximum position, maximum trades, account allowlists, or instrument allowlists. Those fields are advisory profile metadata.

The built-in agent and rion-scout baseline IDs currently bypass specialized-profile filtering. See Agent Builder for the exact enforced and advisory controls.

Local HTTP API Is A Separate Boundary

Agent Builder profiles do not create per-agent HTTP tokens or per-agent API scopes. A request to the Local Desktop API is governed by:

1. the desktop token
2. optional request-signing policy
3. the permission required by the route/resolved action
4. license entitlements and local settings
5. the Hyperion Sim account restriction for trading actions

It does not apply the selected profile's context filter to global API read routes.

Use Local Desktop API for the complete route list, token-provisioning limitation, permissions, audit behavior, and Preview compatibility rules.

Code Lab Automation Boundary

The current scoped Code Lab action route can:

• open Code Lab
• list custom scripts
• start a custom-project compile
• report compile state

It cannot create or edit a script file, and it cannot implement a standalone validate-script <path> operation. Rion chat can draft source text, but a user must review and place that source into the supported Code Lab workflow.

When preparing a script, use the public HyperionX contract:

• choose the documented HyperionX.Custom namespace and base class for the extension type
• use [HyperionXProperty] for editable settings
• follow the required lifecycle, including OnStateChanged() and OnBarUpdate() where applicable
• use Series<double> and AddSeries(...) for custom outputs
• use documented HyperionX drawing and order helpers
• compile against the target installed version and fix every diagnostic

Start with the Developer Center, API Status and Compatibility, and Code Lab API Reference.

Trading Actions

The 1.1.10 HTTP action surface is Hyperion Sim only. It can place supported simulated orders and cancel, modify, close, or flatten simulated state after the required gates pass.

A newer release-enabled build can expose guarded Hyperliquid and KuCoin live actions. The live_trade entitlement value alone does not enable those routes: provider-specific capabilities and settings, the active chart/account match, connection state, exchange permissions, and instrument scope must also permit them. See Local Agent Live Trading API.

For direct HTTP calls, confirmation is supplied by a request field such as confirmed or executeTrading. The caller must obtain the user's decision; the API does not independently open a desktop confirmation prompt.

CLI Status

Commands such as hx chart snapshot, hx codelab build, and hx codelab validate-script describe a possible future CLI. No supported hx CLI ships with the current desktop API.

Do not publish scripts or automation that depend on those commands until the CLI status changes in the release documentation.