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.

Reviewed 1.1.27 source

Default HyperionX Cloud chat uses grounded conversation tools for chart queries, indicators, verified high/low drawings, and task-owned Code Lab indicators. It has no trading, Strategy Discovery, Validator, Optimizer, or Research Lab execution tool. Other providers and older builds can use legacy routing. Check the installed build and capabilities against the documentation version map; source availability does not establish public-release availability.

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 where those actions exist. In the reviewed 1.1.27 grounded Cloud path, permitted tools are selected and checked against the profile policy; enabling an order-routing toggle does not add a trading tool to that engine.

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 selected account/provider trading policy, including separate Hyperion Sim, live Hyperliquid, and live KuCoin settings where the installed build exposes them

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 scoped HTTP route POST /api/v1/rion/code-lab/action can:

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

That route cannot create or edit a script file, and it cannot implement a standalone validate-script <path> operation.

The in-app grounded Cloud conversation is a separate surface. In reviewed 1.1.27 source, with the required profile permissions and Code Lab entitlement, it can read the authoring API, create or revise a task-owned indicator, compile it, inspect source and diagnostics, and open it in Code Lab. Generated source lives under Indicators\Rion in the configured custom project. Existing unowned files cannot be overwritten, and external edits to an owned file cause a conflict rather than being silently replaced.

The artifact tools return real compiler results and support bounded repair attempts. A successful compile does not prove correct runtime behavior, correct session calculations, or successful historical validation. Review and test the artifact separately. Providers and builds without these tools can still draft source for the user to place and compile manually.

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 reviewed 1.1.27 default Cloud conversation has no trading-execution tool. The HTTP routes described here are separate; a chat answer is not an HTTP trading result.

The installed Local Desktop API can expose Hyperion Sim actions and, in a release-enabled build, guarded Hyperliquid and KuCoin live actions. Discover the available paths from the installed capabilities and selected trading-state payload rather than assuming a version or entitlement enables them.

The sim_trade or live_trade entitlement value alone does not enable an action. The matching default-off provider setting, active chart/account match, connection state, exchange permissions, and instrument scope must also permit it. 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.