How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Clear Street Omni AI API

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.

Clear Street Omni AI API is one of 23 APIs that Clear Street publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Omni AI. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and a changelog.

This API exposes 14 operations across 10 paths, and defines 68 schemas. It is described by OpenAPI 3.2.0, at version 2025-10-31.

Requests are made against 3 base URLs: https://api.clearstreet.com, https://api-dev.clearstreet.com, http://localhost:5001.

14 operations 10 paths 68 schemas 2 DELETE8 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2025-10-31
Base URL
https://api.clearstreet.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Clear Street Omni AI API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

Paths & Operations 14

Across 10 paths, the API surfaces 14 operations — 2 DELETE, 8 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Omni AI 14

Thread-centric AI assistant for conversational trading. Create threads to start conversations, poll response objects for in-progress output, and read finalized messages from threa…

GET
/v1/omni-ai/entitlement-agreements
Get Entitlement Agreements
get_entitlement_agreements → 200404500
GET
/v1/omni-ai/entitlements
Get Entitlements
get_entitlements 1 param → 200403500
POST
/v1/omni-ai/entitlements
Create Entitlements
create_entitlements body → 200400403500
DELETE
/v1/omni-ai/entitlements/{entitlement_id}
Delete Entitlement
delete_entitlement 1 param → 200404409500
GET
/v1/omni-ai/messages/{message_id}
Get Message By ID
get_message_by_id 2 params → 200400403404500
POST
/v1/omni-ai/messages/{message_id}/feedback
Submit Feedback
submit_feedback 1 param body → 200400403422500
GET
/v1/omni-ai/responses/{response_id}
Get Response By ID
get_response_by_id 2 params → 200400403404500
DELETE
/v1/omni-ai/responses/{response_id}
Cancel Response
cancel_response 2 params → 200400403404500
GET
/v1/omni-ai/threads
Get Threads
get_threads 3 params → 200400500
POST
/v1/omni-ai/threads
Create Thread
create_thread body → 200400422500
GET
/v1/omni-ai/threads/{thread_id}
Get Thread By ID
get_thread_by_id 2 params → 200400403404500
GET
/v1/omni-ai/threads/{thread_id}/messages
Get Messages
get_messages 4 params → 200403404500
POST
/v1/omni-ai/threads/{thread_id}/messages
Create Message
create_message 1 param body → 200400409422500
GET
/v1/omni-ai/threads/{thread_id}/response
Get Thread Response
get_thread_response 2 params → 200403404500

Schemas 68

The contract defines 68 schemas that model the data the API accepts and returns. The most detailed are NewOrderRequest (14 properties), Message (8 properties), Response (7 properties), EntitlementAgreementResource (7 properties). Each schema is shown below with its type and property counts.

EntitlementResource
object
5 properties 5 required
Side
string
Side of an order
OpenEntitlementConsentAction
object
Action to open entitlement consent flow for one or more accounts.
4 properties 4 required
InstrumentIdOrSymbol
string
Instrument identifier: either an instrument UUID or a symbol (symbol for equities, OSI for options). Non-UUID inputs are resolved server-side.
ContentPartSuggestedActionsPayload
object
Suggested actions payload content part.
1 property 1 required
DeepInsightsTargetType
string
Deep-insights target type. Launch supports ticker-only.
CreateThreadRequest
object
Create-thread request body.
6 properties 2 required
ScreenerFilter
object
A single filter criterion for the screener.
3 properties 3 required
Message
object
Final immutable message.
8 properties 7 required
ResponseContentPart
Dynamic content part visible on a pollable response.
Thread
object
Thread metadata returned by list/get thread endpoints.
4 properties 4 required
EntitlementResourceList
array
ErrorDetails
array
ContentPartStructuredActionPayload
object
Structured action content part.
2 properties 2 required
PromptButtonAction
object
Prompt-style button behavior.
1 property 1 required
MessageOutcome
string
Immutable terminal outcome for a finalized assistant message.
CreateMessageResponse
object
Response payload for continuing a thread with a new message.
3 properties 3 required
PrefillNewOrderAction
object
New-order prefill action.
1 property 1 required
MessageContentPart
Final immutable content part visible on persisted messages.
PrefillModifyOrderRequest
One order modification emitted as part of an Omni prefill action. The replace-order REST endpoint carries accountid and orderid in its path and accepts Replace…
ResponseMetadata
object
Metadata for the response. This will always contain a request ID which can be used to identify the request to Clear Street for tracing, and optionally may incl…
6 properties 1 required
DataChart
object
Chart represented by explicit data series.
1 property
MessageContent
object
Finalized immutable message content container. Never includes thinking parts.
1 property 1 required
ResponseContent
object
Dynamic response content container. May include thinking parts.
1 property 1 required
ContentPartTextPayload
object
Text content part.
1 property 1 required
EntitlementAgreementResourceList
array
EntitlementAgreementResource
object
7 properties 7 required
TrailingOffsetType
string
Trailing offset type for trailing stop orders.
NewOrderRequest
object
Request to submit a new order (PlaceOrderRequest from spec)
14 properties 4 required
ErrorStatus
object
Shared sanitized error payload.
3 properties 2 required
StructuredActionButtonAction
object
Structured-action button behavior.
1 property
ContentPartThinkingPayload
object
Thinking content part shown on dynamic response polling.
1 property 1 required
RequestTimeInForce
string
Strict time-in-force enum for order submission requests.
ThreadList
array
CancelResponsePayload
object
1 property 1 required
ApiError
object
A direct mapping of tonic::Status, for use in HTTP responses.
3 properties 2 required
CancelOrderRequest
object
Request to cancel an existing order Note: In the API, order cancellation is done via DELETE request without a body. The orderid and accountid come from the URL…
2 properties 2 required
RequestOrderType
string
Strict order-type enum for order submission/replacement requests.
EntitlementAgreementKey
string
Stable entitlement agreement family key.
ChartSeries
object
Named data series within a chart.
2 properties 1 required
CreateFeedbackRequest
object
4 properties 2 required
CreateEntitlementsRequest
object
3 properties 3 required
PrefillModifyOrderAction
object
Modify-order prefill action.
1 property 1 required
PrefillCancelOrderAction
object
Cancel-order prefill action.
1 property 1 required
OpenScreenerAction
object
Action to open a stock screener with filters.
5 properties 1 required
ActionButton
object
Button metadata shared by chart and suggested-actions payloads.
4 properties 2 required
MessageRole
string
Finalized message role in the public contract.
DeepInsightsTarget
object
Deep-insights target payload.
2 properties 2 required
ChartPayload
object
Typed chart payload rendered inline in assistant content.
3 properties 1 required
SuggestedActionsPayload
object
Suggested follow-up buttons rendered at the end of an assistant message.
1 property
Capability
string
Capability allowlist for structured actions. Clients declare which capabilities they support when starting a run. Omni AI will only emit structured actions tha…
StructuredAction
Structured actions that Omni AI can return to clients. These actions provide machine-readable instructions for the client to execute, such as prefilling an ord…
OpenChartAction
object
Action to open a chart for a symbol.
3 properties 1 required
ResponseStatus
string
Dynamic lifecycle status for a pollable response.
EntitlementCode
string
Stable entitlement code granted by an agreement.
CreateFeedbackResponse
object
2 properties 1 required
ChartPoint
object
Single chart coordinate.
2 properties 2 required
i64
integer
PrefillOrderAction
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…
ContentPartChartPayload
object
Chart payload content part.
1 property 1 required
DeleteEntitlementResponse
object
2 properties 2 required
ConversationMode
string
Thread creation mode.
MessageList
array
ContentPartCustomPayload
object
Escape-hatch custom payload content part.
1 property 1 required
CreateMessageRequest
object
Continue-thread message creation request body.
3 properties 2 required
CreateThreadResponse
object
Response payload for thread creation.
3 properties 3 required
Response
object
Dynamic pollable response.
7 properties 4 required
BaseResponse
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

clear-street-omni-ai-api-openapi.yml Raw ↑

Other APIs Clear Street publishes across the network.

Clear Street MCP Server
Clear Street API (Trades and Uploads)
Clear Street Accounts API
Clear Street API version API
Clear Street Calendar API
Clear Street Entities API
Clear Street Holdings API
Clear Street Instrument Data API
Clear Street Instruments API
Clear Street Inventories API
Clear Street Locates API
Clear Street Margin API
Where this information came from

This is an independent, third-party profile of Clear Street Omni AI API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.