API Reference

V1

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Omni AI

ModelsExpand Collapse

type ActionButton struct{…}

Button metadata shared by chart and suggested-actions payloads.

ButtonID string

Stable button identifier within the content part.

Label string

User-visible label.

Prompt PromptButtonActionOptional

Follow-up prompt to submit as the next user message.

Prompt string

Prompt text to submit as the next user turn.

StructuredAction StructuredActionButtonActionOptional

Structured action in the same message to execute on click.

ActionID stringOptional

UUID of a structured_action content part in the same message.

formatuuid

type ChartPayload struct{…}

Typed chart payload rendered inline in assistant content.

ChartID string

Stable chart identifier scoped to the content part.

ActionButtons []ActionButtonOptional

Buttons associated with this chart.

ButtonID string

Stable button identifier within the content part.

Label string

User-visible label.

Prompt PromptButtonActionOptional

Follow-up prompt to submit as the next user message.

Prompt string

Prompt text to submit as the next user turn.

StructuredAction StructuredActionButtonActionOptional

Structured action in the same message to execute on click.

ActionID stringOptional

UUID of a structured_action content part in the same message.

formatuuid

DataChart DataChartOptional

Explicit series-driven chart definition.

Series []ChartSeriesOptional

Name string

Points []ChartPointOptional

X string

Y float64

SymbolChart SymbolChartOptional

Symbol-driven chart definition.

Symbol string

Timeframe stringOptional

type ChartPoint struct{…}

Single chart coordinate.

X string

Y float64

type ChartSeries struct{…}

Named data series within a chart.

Name string

Points []ChartPointOptional

X string

Y float64

type ContentPartChartPayload struct{…}

Chart payload content part.

Payload ChartPayload

Typed chart payload rendered inline in assistant content.

ChartID string

Stable chart identifier scoped to the content part.

ActionButtons []ActionButtonOptional

Buttons associated with this chart.

ButtonID string

Stable button identifier within the content part.

Label string

User-visible label.

Prompt PromptButtonActionOptional

Follow-up prompt to submit as the next user message.

Prompt string

Prompt text to submit as the next user turn.

StructuredAction StructuredActionButtonActionOptional

Structured action in the same message to execute on click.

ActionID stringOptional

UUID of a structured_action content part in the same message.

formatuuid

DataChart DataChartOptional

Explicit series-driven chart definition.

Series []ChartSeriesOptional

Name string

Points []ChartPointOptional

X string

Y float64

SymbolChart SymbolChartOptional

Symbol-driven chart definition.

Symbol string

Timeframe stringOptional

type ContentPartCustomPayload struct{…}

Escape-hatch custom payload content part.

Payload any

type ContentPartStructuredActionPayload struct{…}

Structured action content part.

Action StructuredActionUnion

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.

One of the following:

type StructuredActionPrefillOrder struct{…}

Prefill an order ticket for user confirmation

PrefillOrder PrefillOrderActionUnion

Prefill an order ticket for user confirmation

One of the following:

type PrefillOrderActionPrefillNewOrderAction struct{…}

Create one or more new orders.

ActionType string

type PrefillOrderActionPrefillCancelOrderAction struct{…}

Cancel one or more existing orders.

ActionType string

type StructuredActionOpenChart struct{…}

Open a chart for a symbol

OpenChart OpenChartAction

Open a chart for a symbol

Symbol string

Trading symbol to chart

Extras anyOptional

Additional chart configuration (indicators, overlays, etc.)

Timeframe stringOptional

Chart timeframe (e.g., “1D”, “1W”, “1M”, “3M”, “1Y”, “5Y”)

type StructuredActionOpenScreener struct{…}

Open a stock screener with filters

OpenScreener OpenScreenerAction

Open a stock screener with filters

Filters []ScreenerFilter

Filter criteria for the screener

Field string

Field to filter on (e.g., “market_cap”, “sector”, “price”)

Operator string

Comparison operator (e.g., “eq”, “gte”, “lte”, “in”)

Value any

Filter value

FieldFilter []stringOptional

Optional field/column selection for screener results.

PageSize int64Optional

Optional page size.

formatint32

SortBy stringOptional

Optional sort field for screener rows.

SortDirection stringOptional

Optional sort direction (ASC or DESC).

type StructuredActionOpenEntitlementConsent struct{…}

Open entitlement consent flow

OpenEntitlementConsent OpenEntitlementConsentAction

Open entitlement consent flow

AgreementKey EntitlementAgreementKey

Stable entitlement agreement family key.

Reason string

RequestedEntitlementCodes []EntitlementCode

TradingAccountIDs []int64

ActionID string

type ContentPartSuggestedActionsPayload struct{…}

Suggested actions payload content part.

Payload SuggestedActionsPayload

Suggested follow-up buttons rendered at the end of an assistant message.

ActionButtons []ActionButtonOptional

Ordered message-level buttons.

ButtonID string

Stable button identifier within the content part.

Label string

User-visible label.

Prompt PromptButtonActionOptional

Follow-up prompt to submit as the next user message.

Prompt string

Prompt text to submit as the next user turn.

StructuredAction StructuredActionButtonActionOptional

Structured action in the same message to execute on click.

ActionID stringOptional

UUID of a structured_action content part in the same message.

formatuuid

type ContentPartTextPayload struct{…}

Text content part.

Text string

type ContentPartThinkingPayload struct{…}

Thinking content part shown on dynamic response polling.

Thoughts []string

type DataChart struct{…}

Chart represented by explicit data series.

Series []ChartSeriesOptional

Name string

Points []ChartPointOptional

X string

Y float64

type OpenChartAction struct{…}

Action to open a chart for a symbol.

Symbol string

Trading symbol to chart

Extras anyOptional

Additional chart configuration (indicators, overlays, etc.)

Timeframe stringOptional

Chart timeframe (e.g., “1D”, “1W”, “1M”, “3M”, “1Y”, “5Y”)

type OpenEntitlementConsentAction struct{…}

Action to open entitlement consent flow for one or more accounts.

AgreementKey EntitlementAgreementKey

Stable entitlement agreement family key.

Reason string

RequestedEntitlementCodes []EntitlementCode

TradingAccountIDs []int64

type OpenScreenerAction struct{…}

Action to open a stock screener with filters.

Filters []ScreenerFilter

Filter criteria for the screener

Field string

Field to filter on (e.g., “market_cap”, “sector”, “price”)

Operator string

Comparison operator (e.g., “eq”, “gte”, “lte”, “in”)

Value any

Filter value

FieldFilter []stringOptional

Optional field/column selection for screener results.

PageSize int64Optional

Optional page size.

formatint32

SortBy stringOptional

Optional sort field for screener rows.

SortDirection stringOptional

Optional sort direction (ASC or DESC).

type PrefillCancelOrderAction struct{…}

Cancel-order prefill action.

Orders []CancelOrderRequest

Orders to cancel using the same identifiers required by the cancel-order API.

AccountID int64

Account ID (from path parameter)

formatint64

OrderID string

Order ID to cancel (from path parameter)

type PrefillNewOrderAction struct{…}

New-order prefill action.

Orders []NewOrderRequest

Orders to prefill using the same shape accepted by the orders API.

InstrumentType SecurityType

Type of security

One of the following:

const SecurityTypeCommonStock SecurityType = "COMMON_STOCK"

const SecurityTypePreferredStock SecurityType = "PREFERRED_STOCK"

const SecurityTypeOption SecurityType = "OPTION"

const SecurityTypeCash SecurityType = "CASH"

const SecurityTypeOther SecurityType = "OTHER"

OrderType RequestOrderType

Type of order

One of the following:

const RequestOrderTypeMarket RequestOrderType = "MARKET"

const RequestOrderTypeLimit RequestOrderType = "LIMIT"

const RequestOrderTypeStop RequestOrderType = "STOP"

const RequestOrderTypeStopLimit RequestOrderType = "STOP_LIMIT"

const RequestOrderTypeTrailingStop RequestOrderType = "TRAILING_STOP"

const RequestOrderTypeTrailingStopLimit RequestOrderType = "TRAILING_STOP_LIMIT"

Quantity string

Quantity to trade. For COMMON_STOCK: shares (may be fractional if supported). For OPTION (single-leg): contracts (must be an integer)

Side Side

Side of the order

One of the following:

const SideBuy Side = "BUY"

const SideSell Side = "SELL"

const SideSellShort Side = "SELL_SHORT"

const SideOther Side = "OTHER"

TimeInForce RequestTimeInForce

Time in force

One of the following:

const RequestTimeInForceDay RequestTimeInForce = "DAY"

const RequestTimeInForceGoodTillCancel RequestTimeInForce = "GOOD_TILL_CANCEL"

const RequestTimeInForceImmediateOrCancel RequestTimeInForce = "IMMEDIATE_OR_CANCEL"

const RequestTimeInForceFillOrKill RequestTimeInForce = "FILL_OR_KILL"

const RequestTimeInForceGoodTillDate RequestTimeInForce = "GOOD_TILL_DATE"

const RequestTimeInForceAtTheOpening RequestTimeInForce = "AT_THE_OPENING"

const RequestTimeInForceAtTheClose RequestTimeInForce = "AT_THE_CLOSE"

const RequestTimeInForceGoodTillCrossing RequestTimeInForce = "GOOD_TILL_CROSSING"

const RequestTimeInForceGoodThroughCrossing RequestTimeInForce = "GOOD_THROUGH_CROSSING"

const RequestTimeInForceAtCrossing RequestTimeInForce = "AT_CROSSING"

ID stringOptional

Optional client-provided unique ID (idempotency). Required to be unique per account.

maxLength64

ExpiresAt TimeOptional

The timestamp when the order should expire (UTC). Required when time_in_force is GOOD_TILL_DATE.

formatdate-time

ExtendedHours boolOptional

Allow trading outside regular trading hours. Some brokers disallow options outside RTH.

InstrumentID InstrumentIDOrSymbolOptional

OEMS instrument UUID

formatuuid

LimitOffset stringOptional

Limit offset for trailing stop-limit orders (signed)

LimitPrice stringOptional

Limit price (required for LIMIT and STOP_LIMIT orders)

PositionEffect PositionEffectOptional

Required when instrument_type is OPTION. Specifies whether the order opens or closes a position.

One of the following:

const PositionEffectOpen PositionEffect = "OPEN"

const PositionEffectClose PositionEffect = "CLOSE"

StopPrice stringOptional

Stop price (required for STOP and STOP_LIMIT orders)

Symbol stringOptional

Trading symbol. For equities, use the ticker symbol (e.g., “AAPL”). For options, use the OSI symbol (e.g., “AAPL 250117C00190000”). Either symbol or instrument_id must be provided.

TrailingOffset stringOptional

Trailing offset amount (required for trailing orders)

TrailingOffsetType TrailingOffsetTypeOptional

Trailing offset type (PRICE or PERCENT_BPS)

One of the following:

const TrailingOffsetTypePrice TrailingOffsetType = "PRICE"

const TrailingOffsetTypeBps TrailingOffsetType = "BPS"

type PrefillOrderActionUnion interface{…}

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.

One of the following:

type PrefillOrderActionPrefillNewOrderAction struct{…}

Create one or more new orders.

ActionType string

type PrefillOrderActionPrefillCancelOrderAction struct{…}

Cancel one or more existing orders.

ActionType string

type PromptButtonAction struct{…}

Prompt-style button behavior.

Prompt string

Prompt text to submit as the next user turn.

type ScreenerFilter struct{…}

A single filter criterion for the screener.

Field string

Field to filter on (e.g., “market_cap”, “sector”, “price”)

Operator string

Comparison operator (e.g., “eq”, “gte”, “lte”, “in”)

Value any

Filter value

type StructuredActionUnion interface{…}

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.

One of the following:

type StructuredActionPrefillOrder struct{…}

Prefill an order ticket for user confirmation

PrefillOrder PrefillOrderActionUnion

Prefill an order ticket for user confirmation

One of the following:

type PrefillOrderActionPrefillNewOrderAction struct{…}

Create one or more new orders.

ActionType string

type PrefillOrderActionPrefillCancelOrderAction struct{…}

Cancel one or more existing orders.

ActionType string

type StructuredActionOpenChart struct{…}

Open a chart for a symbol

OpenChart OpenChartAction

Open a chart for a symbol

Symbol string

Trading symbol to chart

Extras anyOptional

Additional chart configuration (indicators, overlays, etc.)

Timeframe stringOptional

Chart timeframe (e.g., “1D”, “1W”, “1M”, “3M”, “1Y”, “5Y”)

type StructuredActionOpenScreener struct{…}

Open a stock screener with filters

OpenScreener OpenScreenerAction

Open a stock screener with filters

Filters []ScreenerFilter

Filter criteria for the screener

Field string

Field to filter on (e.g., “market_cap”, “sector”, “price”)

Operator string

Comparison operator (e.g., “eq”, “gte”, “lte”, “in”)

Value any

Filter value

FieldFilter []stringOptional

Optional field/column selection for screener results.

PageSize int64Optional

Optional page size.

formatint32

SortBy stringOptional

Optional sort field for screener rows.

SortDirection stringOptional

Optional sort direction (ASC or DESC).

type StructuredActionOpenEntitlementConsent struct{…}

Open entitlement consent flow

OpenEntitlementConsent OpenEntitlementConsentAction

Open entitlement consent flow

AgreementKey EntitlementAgreementKey

Stable entitlement agreement family key.

Reason string

RequestedEntitlementCodes []EntitlementCode

TradingAccountIDs []int64

type StructuredActionButtonAction struct{…}

Structured-action button behavior.

ActionID stringOptional

UUID of a structured_action content part in the same message.

formatuuid

type SuggestedActionsPayload struct{…}

Suggested follow-up buttons rendered at the end of an assistant message.

ActionButtons []ActionButtonOptional

Ordered message-level buttons.

ButtonID string

Stable button identifier within the content part.

Label string

User-visible label.

Prompt PromptButtonActionOptional

Follow-up prompt to submit as the next user message.

Prompt string

Prompt text to submit as the next user turn.

StructuredAction StructuredActionButtonActionOptional

Structured action in the same message to execute on click.

ActionID stringOptional

UUID of a structured_action content part in the same message.

formatuuid

type SymbolChart struct{…}

Chart for a single symbol and timeframe.

Symbol string

Timeframe stringOptional

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 trading_account_ids.

Get Entitlements

client.V1.OmniAI.Entitlements.GetEntitlements(ctx, query) (*V1OmniAIEntitlementGetEntitlementsResponse, error)

GET/v1/omni-ai/entitlements

Create Entitlements

client.V1.OmniAI.Entitlements.NewEntitlements(ctx, body) (*V1OmniAIEntitlementNewEntitlementsResponse, error)

POST/v1/omni-ai/entitlements

Delete Entitlement

client.V1.OmniAI.Entitlements.DeleteEntitlement(ctx, entitlementID) (*V1OmniAIEntitlementDeleteEntitlementResponse, error)

DELETE/v1/omni-ai/entitlements/{entitlement_id}

Get Entitlement Agreements

client.V1.OmniAI.Entitlements.GetEntitlementAgreements(ctx) (*V1OmniAIEntitlementGetEntitlementAgreementsResponse, error)

GET/v1/omni-ai/entitlement-agreements

ModelsExpand Collapse

type DeleteEntitlementResponse struct{…}

EntitlementID string

Revoked bool

type EntitlementAgreementKey string

Stable entitlement agreement family key.

type EntitlementAgreementResource struct{…}

AgreementID string

AgreementKey EntitlementAgreementKey

Stable entitlement agreement family key.

DocumentContent string

DocumentSha256 string

EntitlementCodes []EntitlementCode

Title string

Version int64

type EntitlementAgreementResourceList []EntitlementAgreementResource

AgreementID string

AgreementKey EntitlementAgreementKey

Stable entitlement agreement family key.

DocumentContent string

DocumentSha256 string

EntitlementCodes []EntitlementCode

Title string

Version int64

type EntitlementCode string

Stable entitlement code granted by an agreement.

type EntitlementResource struct{…}

AgreementID string

EntitlementCode EntitlementCode

Stable entitlement code granted by an agreement.

EntitlementID string

GrantedAt string

TradingAccountID int64

type EntitlementResourceList []EntitlementResource

AgreementID string

EntitlementCode EntitlementCode

Stable entitlement code granted by an agreement.

EntitlementID string

GrantedAt string

TradingAccountID int64

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 trading_account_ids.

Get Message By ID

client.V1.OmniAI.Messages.GetMessageByID(ctx, messageID, query) (*V1OmniAIMessageGetMessageByIDResponse, error)

GET/v1/omni-ai/messages/{message_id}

Submit Feedback

client.V1.OmniAI.Messages.SubmitFeedback(ctx, messageID, body) (*V1OmniAIMessageSubmitFeedbackResponse, error)

POST/v1/omni-ai/messages/{message_id}/feedback

ModelsExpand Collapse

type CreateFeedbackResponse struct{…}

CreatedAt string

FeedbackID stringOptional

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 trading_account_ids.

Get Response By ID

client.V1.OmniAI.Responses.GetResponseByID(ctx, responseID, query) (*V1OmniAIResponseGetResponseByIDResponse, error)

GET/v1/omni-ai/responses/{response_id}

Cancel Response

client.V1.OmniAI.Responses.CancelResponse(ctx, responseID, body) (*V1OmniAIResponseCancelResponseResponse, error)

DELETE/v1/omni-ai/responses/{response_id}

ModelsExpand Collapse

type CancelResponsePayload struct{…}

Canceled bool

type ErrorStatus struct{…}

Shared sanitized error payload.

Code string

Message string

Details anyOptional

type Response struct{…}

Dynamic pollable response.

ID string

Status ResponseStatus

Dynamic lifecycle status for a pollable response.

One of the following:

const ResponseStatusQueued ResponseStatus = "queued"

const ResponseStatusRunning ResponseStatus = "running"

const ResponseStatusSucceeded ResponseStatus = "succeeded"

const ResponseStatusFailed ResponseStatus = "failed"

const ResponseStatusCanceled ResponseStatus = "canceled"

ThreadID string

UserMessageID string

Content ResponseContentOptional

Dynamic response content container. May include thinking parts.

Parts []ResponseContentPartUnion

One of the following:

type ResponseContentPartObject struct{…}

Text content part.

Type string

type ResponseContentPartObject2 struct{…}

Thinking content part shown on dynamic response polling.

Type string

type ResponseContentPartObject3 struct{…}

Structured action content part.

Type string

type ResponseContentPartObject4 struct{…}

Chart payload content part.

Type string

type ResponseContentPartObject5 struct{…}

Suggested actions payload content part.

Type string

type ResponseContentPartObject6 struct{…}

Escape-hatch custom payload content part.

Type string

Error ErrorStatusOptional

Shared sanitized error payload.

Code string

Message string

Details anyOptional

OutputMessageID stringOptional

type ResponseContent struct{…}

Dynamic response content container. May include thinking parts.

Parts []ResponseContentPartUnion

One of the following:

type ResponseContentPartObject struct{…}

Text content part.

Type string

type ResponseContentPartObject2 struct{…}

Thinking content part shown on dynamic response polling.

Type string

type ResponseContentPartObject3 struct{…}

Structured action content part.

Type string

type ResponseContentPartObject4 struct{…}

Chart payload content part.

Type string

type ResponseContentPartObject5 struct{…}

Suggested actions payload content part.

Type string

type ResponseContentPartObject6 struct{…}

Escape-hatch custom payload content part.

Type string

type ResponseContentPartUnion interface{…}

Dynamic content part visible on a pollable response.

One of the following:

type ResponseContentPartObject struct{…}

Text content part.

Type string

type ResponseContentPartObject2 struct{…}

Thinking content part shown on dynamic response polling.

Type string

type ResponseContentPartObject3 struct{…}

Structured action content part.

Type string

type ResponseContentPartObject4 struct{…}

Chart payload content part.

Type string

type ResponseContentPartObject5 struct{…}

Suggested actions payload content part.

Type string

type ResponseContentPartObject6 struct{…}

Escape-hatch custom payload content part.

Type string

type ResponseStatus string

Dynamic lifecycle status for a pollable response.

One of the following:

const ResponseStatusQueued ResponseStatus = "queued"

const ResponseStatusRunning ResponseStatus = "running"

const ResponseStatusSucceeded ResponseStatus = "succeeded"

const ResponseStatusFailed ResponseStatus = "failed"

const ResponseStatusCanceled ResponseStatus = "canceled"

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 trading_account_ids.

Get Threads

client.V1.OmniAI.Threads.GetThreads(ctx, query) (*V1OmniAIThreadGetThreadsResponse, error)

GET/v1/omni-ai/threads

Get Thread By ID

client.V1.OmniAI.Threads.GetThreadByID(ctx, threadID, query) (*V1OmniAIThreadGetThreadByIDResponse, error)

GET/v1/omni-ai/threads/{thread_id}

Create Thread

client.V1.OmniAI.Threads.NewThread(ctx, body) (*V1OmniAIThreadNewThreadResponse, error)

POST/v1/omni-ai/threads

Get Thread Response

client.V1.OmniAI.Threads.GetThreadResponse(ctx, threadID, query) (*V1OmniAIThreadGetThreadResponseResponse, error)

GET/v1/omni-ai/threads/{thread_id}/response

Get Messages

client.V1.OmniAI.Threads.GetMessages(ctx, threadID, query) (*V1OmniAIThreadGetMessagesResponse, error)

GET/v1/omni-ai/threads/{thread_id}/messages

Create Message

client.V1.OmniAI.Threads.NewMessage(ctx, threadID, body) (*V1OmniAIThreadNewMessageResponse, error)

POST/v1/omni-ai/threads/{thread_id}/messages

ModelsExpand Collapse

type CreateMessageResponse struct{…}

Response payload for continuing a thread with a new message.

ResponseID string

ThreadID string

UserMessageID string

type CreateThreadResponse struct{…}

Response payload for thread creation.

ResponseID string

ThreadID string

UserMessageID string

type Message struct{…}

Final immutable message.

ID string

Content MessageContent

Finalized immutable message content container. Never includes thinking parts.

Parts []MessageContentPartUnion

One of the following:

type MessageContentPartObject struct{…}

Text content part.

Type string

type MessageContentPartObject2 struct{…}

Structured action content part.

Type string

type MessageContentPartObject3 struct{…}

Chart payload content part.

Type string

type MessageContentPartObject4 struct{…}

Suggested actions payload content part.

Type string

type MessageContentPartObject5 struct{…}

Escape-hatch custom payload content part.

Type string

CreatedAt string

Outcome MessageOutcome

Immutable terminal outcome for a finalized assistant message.

One of the following:

const MessageOutcomeCompleted MessageOutcome = "completed"

const MessageOutcomeErrored MessageOutcome = "errored"

const MessageOutcomeCanceled MessageOutcome = "canceled"

Role MessageRole

Finalized message role in the public contract.

One of the following:

const MessageRoleUser MessageRole = "USER"

const MessageRoleAssistant MessageRole = "ASSISTANT"

Seq int64

ThreadID string

Error ErrorStatusOptional

Shared sanitized error payload.

Code string

Message string

Details anyOptional

type MessageContent struct{…}

Finalized immutable message content container. Never includes thinking parts.

Parts []MessageContentPartUnion

One of the following:

type MessageContentPartObject struct{…}

Text content part.

Type string

type MessageContentPartObject2 struct{…}

Structured action content part.

Type string

type MessageContentPartObject3 struct{…}

Chart payload content part.

Type string

type MessageContentPartObject4 struct{…}

Suggested actions payload content part.

Type string

type MessageContentPartObject5 struct{…}

Escape-hatch custom payload content part.

Type string

type MessageContentPartUnion interface{…}

Final immutable content part visible on persisted messages.

One of the following:

type MessageContentPartObject struct{…}

Text content part.

Type string

type MessageContentPartObject2 struct{…}

Structured action content part.

Type string

type MessageContentPartObject3 struct{…}

Chart payload content part.

Type string

type MessageContentPartObject4 struct{…}

Suggested actions payload content part.

Type string

type MessageContentPartObject5 struct{…}

Escape-hatch custom payload content part.

Type string

type MessageList []Message

ID string

Content MessageContent

Finalized immutable message content container. Never includes thinking parts.

Parts []MessageContentPartUnion

One of the following:

type MessageContentPartObject struct{…}

Text content part.

Type string

type MessageContentPartObject2 struct{…}

Structured action content part.

Type string

type MessageContentPartObject3 struct{…}

Chart payload content part.

Type string

type MessageContentPartObject4 struct{…}

Suggested actions payload content part.

Type string

type MessageContentPartObject5 struct{…}

Escape-hatch custom payload content part.

Type string

CreatedAt string

Outcome MessageOutcome

Immutable terminal outcome for a finalized assistant message.

One of the following:

const MessageOutcomeCompleted MessageOutcome = "completed"

const MessageOutcomeErrored MessageOutcome = "errored"

const MessageOutcomeCanceled MessageOutcome = "canceled"

Role MessageRole

Finalized message role in the public contract.

One of the following:

const MessageRoleUser MessageRole = "USER"

const MessageRoleAssistant MessageRole = "ASSISTANT"

Seq int64

ThreadID string

Error ErrorStatusOptional

Shared sanitized error payload.

Code string

Message string

Details anyOptional

type MessageOutcome string

Immutable terminal outcome for a finalized assistant message.

One of the following:

const MessageOutcomeCompleted MessageOutcome = "completed"

const MessageOutcomeErrored MessageOutcome = "errored"

const MessageOutcomeCanceled MessageOutcome = "canceled"

type MessageRole string

Finalized message role in the public contract.

One of the following:

const MessageRoleUser MessageRole = "USER"

const MessageRoleAssistant MessageRole = "ASSISTANT"

type Thread struct{…}

Thread metadata returned by list/get thread endpoints.

ID string

CreatedAt string

Title string

UpdatedAt string

type ThreadList []Thread

ID string

CreatedAt string

Title string

UpdatedAt string