Forge API

Forge exposes the supported integration boundary for Aurum operations, live runtime data, and historical data. Terminal uses this same boundary; an external integration does not connect directly to aurumd, a strategy process, or ClickHouse.

API base

Configure one browser-reachable base URL ending in /api/v1:

https://forge.example.com/api/v1

Append paths from this section to that base. Use https and wss outside a trusted private network. Authentication and network policy are defined by the Forge environment supplied to your organization.

Three data planes

Plane

Interface

Use

Control

REST instance endpoints

Inventory, health, lifecycle, and logs.

Live

Runtime REST and WebSocket

Capabilities, resource discovery, current values, and subscriptions.

History

Forge history REST

Run-scoped summaries and durable resource rows.

Start with REST discovery

Before opening a live subscription:

  1. call GET /instances and select an exact instanceId;

  2. call GET /runtime/status?instance=<id>;

  3. check the relevant capability flag;

  4. call GET /runtime/resources?instance=<id> and copy the resource key;

  5. open the instance WebSocket and subscribe to that key.

Do not derive a resource key from a Terminal label. Keys, capabilities, and history contracts are runtime data and can differ between projects.

JSON conventions

Forge product responses are protobuf JSON. Field names are lower camel case, 64-bit integers are encoded as JSON strings, and zero-valued fields are present. History responses use their documented snake-case fields and may be newline-delimited JSON.