Docs/API Reference

API Reference

Authentication, streaming, threads, runs, tools, and marketplace APIs.

Authentication and bearer tokens

NOME uses bearer token authentication on all API endpoints. Tokens are issued through the canonical sign-in flow (WorkOS for enterprise, Google/Firebase for personal accounts).

Every request should include X-Nome-Client-Surface, X-Nome-Client-Version, and X-Nome-Client-Revision headers for build identity tracking.

Chat streaming (SSE protocol)

Chat endpoints use Server-Sent Events (SSE) for real-time streaming. Events include run.started, text deltas, tool calls, approval requests, and run.completed.

The streaming protocol preserves the full harness contract — every streamed event carries run ID, work item ID, and receipt metadata.

Thread and message management

Threads are the canonical conversation container. List, create, rename, and delete threads through the API. Thread history is cross-device and cross-session.

Messages within threads carry full metadata including domain hints, tier used, tools invoked, and episode IDs for replay.

Run lifecycle: create, monitor, replay

Runs are created through chat, Agents, or direct API calls. Each run has a lifecycle: pending → active → completed/failed.

The durable run event log supports monitoring active runs and replaying completed runs. Events are append-only and typed for deterministic replay.

Tool execution and approval queue

Tools are invoked within runs and produce typed receipts. Dangerous tools require approval — the approval queue surfaces pending requests across all devices.

The tool policy matrix defines per-tool governance that the API enforces: max calls, approval tiers, offline behavior, and allowed roles.

Marketplace and account APIs

Marketplace endpoints manage package discovery, install state, and Git repo imports. Account endpoints resolve bootstrap, usage/credits, downloads, and billing state.

All marketplace and account operations respect tenant guardrails and entitlement prerequisites.

Webhooks and connectors

NOME supports webhook ingestion from GitHub, Slack, Google Workspace, and WhatsApp. Each connector has its own verification path (signing secrets, OAuth tokens).

Connector installs expose lifecycle state through health checks, refresh seams, and failure summaries. Sweep jobs handle degraded-install recovery.

Ready to try it?

Open NOME

Futures, foreign currency, and options trading contains substantial risk and is not for every investor. An investor could potentially lose all or more than the initial investment. Risk capital is money that can be lost without jeopardizing one’s financial security or lifestyle. Only risk capital should be used for trading and only those with sufficient risk capital should consider trading. Past performance is not necessarily indicative of future results.

Hypothetical or simulated performance results have certain limitations. Unlike an actual performance record, simulated results do not represent actual trading. Also, since the trades have not been executed, the results may have under- or over-compensated for the impact, if any, of certain market factors, such as lack of liquidity. Simulated trading programs in general are also subject to the fact that they are designed with the benefit of hindsight. No representation is being made that any account will or is likely to achieve profits or losses similar to those shown.

NinjaTrader® is a registered trademark of NinjaTrader Group, LLC. No NinjaTrader company has any affiliation with the owner, developer, or provider of the products or services described herein, or any interest, ownership or otherwise, in any such product or service, or endorses, recommends or approves any such product or service.

Nomad Maraud may receive compensation when users register through partner links. This does not constitute a recommendation to trade futures or open a brokerage account.

NOME