Omni AI
ModelsExpand Collapse
class ActionButton:
Button metadata shared by chart and suggested-actions payloads.
Optional<String> itemId
Interaction-tracking identity. Absent on messages created before tracking. When a null/undefined value is observed, it indicates that there is no available data.
class ChartPayload:
Typed chart payload rendered inline in assistant content.
Buttons associated with this chart.
Optional<String> itemId
Interaction-tracking identity. Absent on messages created before tracking. When a null/undefined value is observed, it indicates that there is no available data.
class ContentPartChartPayload:
Chart payload content part.
ChartPayload payload
Typed chart payload rendered inline in assistant content.
Buttons associated with this chart.
Optional<String> itemId
Interaction-tracking identity. Absent on messages created before tracking. When a null/undefined value is observed, it indicates that there is no available data.
class ContentPartStructuredActionPayload:
Structured action content part.
StructuredAction action
Structured actions that Omni AI can return to clients.
These actions provide machine-readable instructions for the client to execute, such as prefilling an order ticket, opening a chart, or navigating to a route.
PrefillOrder
PrefillOrderAction prefillOrder
OpenChart
OpenChartAction openChart
Open a chart for a symbol
Optional<JsonValue> extras
Additional chart configuration (indicators, overlays, etc.) When a null/undefined value is observed, it indicates it does not apply.
OpenScreener
OpenScreenerAction openScreener
Open a stock screener with filters
List<ScreenerFilter> filters
Optional<List<String>> columns
Optional field/column selection for screener results. When a null/undefined value is observed, it indicates it does not apply.
Optional<String> itemId
Interaction-tracking identity. Absent on messages created before tracking. When a null/undefined value is observed, it indicates that there is no available data.
Optional<Long> pageSize
Optional page size. When a null/undefined value is observed, it indicates it does not apply.
OpenEntitlementConsent
OpenEntitlementConsentAction openEntitlementConsent
Open entitlement consent flow
EntitlementAgreementKey agreementKey
Stable entitlement agreement family key.
class ContentPartSuggestedActionsPayload:
Suggested actions payload content part.
SuggestedActionsPayload payload
Suggested follow-up buttons rendered at the end of an assistant message.
Ordered message-level buttons.
Optional<String> itemId
Interaction-tracking identity. Absent on messages created before tracking. When a null/undefined value is observed, it indicates that there is no available data.
class OpenChartAction:
Action to open a chart for a symbol.
Optional<JsonValue> extras
Additional chart configuration (indicators, overlays, etc.) When a null/undefined value is observed, it indicates it does not apply.
class OpenEntitlementConsentAction:
Action to open entitlement consent flow for one or more accounts.
EntitlementAgreementKey agreementKey
Stable entitlement agreement family key.
class OpenScreenerAction:
Action to open a stock screener with filters.
List<ScreenerFilter> filters
Optional<List<String>> columns
Optional field/column selection for screener results. When a null/undefined value is observed, it indicates it does not apply.
Optional<String> itemId
Interaction-tracking identity. Absent on messages created before tracking. When a null/undefined value is observed, it indicates that there is no available data.
Optional<Long> pageSize
Optional page size. When a null/undefined value is observed, it indicates it does not apply.
class PrefillCancelOrderAction:
Cancel-order prefill action.
List<PrefillCancelOrderRequest> orders
Orders to cancel using the same identifiers required by the cancel-order API.
class PrefillModifyOrderAction:
Modify-order prefill action.
List<PrefillModifyOrderRequest> orders
class PrefillModifyOrderRequest:
class PrefillNewOrderAction:
New-order prefill action.
List<PrefillNewOrderRequest> orders
Orders to prefill using the same shape accepted by the orders API.
RequestOrderType orderType
String quantity
Quantity to trade. For COMMON_STOCK: shares (may be fractional if supported). For OPTION (single-leg): contracts (must be an integer)
Side side
RequestTimeInForce timeInForce
Optional<String> id
Optional client-provided unique ID (idempotency). Required to be unique per account.
Optional<LocalDateTime> expiresAt
The timestamp when the order should expire (UTC). Required when time_in_force is GOOD_TILL_DATE.
Optional<Boolean> extendedHours
Allow trading outside regular trading hours. Some brokers disallow options outside RTH.
Optional<String> instrumentId
Instrument ID (UUID) or symbol (equity ticker or OSI option symbol). Either symbol or instrument_id must be provided.
Optional<String> itemId
Interaction-tracking identity. Absent on messages created before tracking. When a null/undefined value is observed, it indicates that there is no available data.
Optional execution strategy. One of SOR, VWAP, or TWAP. Defaults to
SOR. VWAP and TWAP are supported only on MARKET and LIMIT orders
with DAY time-in-force, and are not supported on OTC common-stock orders.
Optional<String> symbol
Trading symbol. For equities, use the ticker symbol (e.g., “TSLA”).
For options, use the OSI symbol (e.g., “TSLA 250117C00190000”).
Either symbol or instrument_id must be provided.
class PrefillNewOrderRequest:
Request to submit a new order
RequestOrderType orderType
String quantity
Quantity to trade. For COMMON_STOCK: shares (may be fractional if supported). For OPTION (single-leg): contracts (must be an integer)
Side side
RequestTimeInForce timeInForce
Optional<String> id
Optional client-provided unique ID (idempotency). Required to be unique per account.
Optional<LocalDateTime> expiresAt
The timestamp when the order should expire (UTC). Required when time_in_force is GOOD_TILL_DATE.
Optional<Boolean> extendedHours
Allow trading outside regular trading hours. Some brokers disallow options outside RTH.
Optional<String> instrumentId
Instrument ID (UUID) or symbol (equity ticker or OSI option symbol). Either symbol or instrument_id must be provided.
Optional<String> itemId
Interaction-tracking identity. Absent on messages created before tracking. When a null/undefined value is observed, it indicates that there is no available data.
Optional execution strategy. One of SOR, VWAP, or TWAP. Defaults to
SOR. VWAP and TWAP are supported only on MARKET and LIMIT orders
with DAY time-in-force, and are not supported on OTC common-stock orders.
Optional<String> symbol
Trading symbol. For equities, use the ticker symbol (e.g., “TSLA”).
For options, use the OSI symbol (e.g., “TSLA 250117C00190000”).
Either symbol or instrument_id must be provided.
class PrefillOrderAction: A class that can be one of several variants.union
Action to prefill order details for user confirmation.
The user must review and authorize the order before submission to the trading API. This action provides parsed order data that can be used to prefill an order ticket UI or submitted directly via the orders API after user confirmation.
class StructuredAction: A class that can be one of several variants.union
Structured actions that Omni AI can return to clients.
These actions provide machine-readable instructions for the client to execute, such as prefilling an order ticket, opening a chart, or navigating to a route.
PrefillOrder
PrefillOrderAction prefillOrder
OpenChart
OpenChartAction openChart
Open a chart for a symbol
Optional<JsonValue> extras
Additional chart configuration (indicators, overlays, etc.) When a null/undefined value is observed, it indicates it does not apply.
OpenScreener
OpenScreenerAction openScreener
Open a stock screener with filters
List<ScreenerFilter> filters
Optional<List<String>> columns
Optional field/column selection for screener results. When a null/undefined value is observed, it indicates it does not apply.
Optional<String> itemId
Interaction-tracking identity. Absent on messages created before tracking. When a null/undefined value is observed, it indicates that there is no available data.
Optional<Long> pageSize
Optional page size. When a null/undefined value is observed, it indicates it does not apply.
OpenEntitlementConsent
OpenEntitlementConsentAction openEntitlementConsent
Open entitlement consent flow
EntitlementAgreementKey agreementKey
Stable entitlement agreement family key.
class SuggestedActionsPayload:
Suggested follow-up buttons rendered at the end of an assistant message.
Ordered message-level buttons.
Optional<String> itemId
Interaction-tracking identity. Absent on messages created before tracking. When a null/undefined value is observed, it indicates that there is no available data.
Omni AIEntitlements
Thread-centric AI assistant for conversational trading. Create threads to start conversations, poll response objects for in-progress output, and read finalized messages from thread history. Thread/message/response endpoints require an explicit account_id. Entitlement endpoints are caller-scoped and use account_ids.
Get Entitlements
Create Entitlements
Delete Entitlement
Get Entitlement Agreements
ModelsExpand Collapse
class EntitlementAgreementResource:
EntitlementAgreementKey agreementKey
Stable entitlement agreement family key.
class EntitlementResource:
EntitlementCode entitlementCode
Stable entitlement code granted by an agreement.
Omni AIMessages
Thread-centric AI assistant for conversational trading. Create threads to start conversations, poll response objects for in-progress output, and read finalized messages from thread history. Thread/message/response endpoints require an explicit account_id. Entitlement endpoints are caller-scoped and use account_ids.
Get Message
Submit Feedback
Omni AIResponses
Thread-centric AI assistant for conversational trading. Create threads to start conversations, poll response objects for in-progress output, and read finalized messages from thread history. Thread/message/response endpoints require an explicit account_id. Entitlement endpoints are caller-scoped and use account_ids.
Get Response By ID
Cancel Response
ModelsExpand Collapse
class Response:
Dynamic pollable response.
ResponseStatus status
When a null/undefined value is observed, it indicates that there is no available data.
List<ResponseContentPart> parts
class ResponseContent:
Dynamic response content container. May include thinking parts.
List<ResponseContentPart> parts
Omni AIThreads
Thread-centric AI assistant for conversational trading. Create threads to start conversations, poll response objects for in-progress output, and read finalized messages from thread history. Thread/message/response endpoints require an explicit account_id. Entitlement endpoints are caller-scoped and use account_ids.
Get Threads
Get Thread
Create Thread
Get Thread Response
Get Messages
Create Message
ModelsExpand Collapse
class Message:
Final immutable message.
MessageContent content
Finalized immutable message content container. Never includes thinking parts.
List<MessageContentPart> parts
MessageOutcome outcome
MessageRole role
Immutable snapshots attached to this user message. Omitted when none were supplied. When a null/undefined value is observed, it indicates that there is no available data.
List<ContextItem> items
One to four snapshots. Each snapshot’s data may contain at most 32 levels of nesting.
class MessageContent:
Finalized immutable message content container. Never includes thinking parts.
List<MessageContentPart> parts
class TurnContext:
Client snapshots attached to one instant-chat user message.
Context is separate from visible message text and does not grant account access. The compact JSON representation must not exceed 64 KiB.
List<ContextItem> items
One to four snapshots. Each snapshot’s data may contain at most 32 levels of nesting.