Skip to content
Clear Street Clear Street
Get started
API Reference
V1
Omni AI

Entitlements

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(EntitlementGetEntitlementsParams { trading_account_id } query?, RequestOptionsoptions?): EntitlementGetEntitlementsResponse { data }
GET/v1/omni-ai/entitlements
Create Entitlements
client.v1.omniAI.entitlements.createEntitlements(EntitlementCreateEntitlementsParams { agreement_id, requested_entitlement_codes, trading_account_ids } body, RequestOptionsoptions?): EntitlementCreateEntitlementsResponse { data }
POST/v1/omni-ai/entitlements
Delete Entitlement
client.v1.omniAI.entitlements.deleteEntitlement(stringentitlementID, RequestOptionsoptions?): EntitlementDeleteEntitlementResponse { data }
DELETE/v1/omni-ai/entitlements/{entitlement_id}
Get Entitlement Agreements
client.v1.omniAI.entitlements.getEntitlementAgreements(RequestOptionsoptions?): EntitlementGetEntitlementAgreementsResponse { data }
GET/v1/omni-ai/entitlement-agreements
ModelsExpand Collapse
DeleteEntitlementResponse { entitlement_id, revoked }
entitlement_id: string
revoked: boolean
EntitlementAgreementKey = "omni_account_data_access"

Stable entitlement agreement family key.

EntitlementAgreementResource { agreement_id, agreement_key, document_content, 4 more }
agreement_id: string
agreement_key: EntitlementAgreementKey { }

Stable entitlement agreement family key.

document_content: string
document_sha256: string
entitlement_codes: Array<EntitlementCode { } >
title: string
version: number
EntitlementAgreementResourceList = Array<EntitlementAgreementResource { agreement_id, agreement_key, document_content, 4 more } >
agreement_id: string
agreement_key: EntitlementAgreementKey { }

Stable entitlement agreement family key.

document_content: string
document_sha256: string
entitlement_codes: Array<EntitlementCode { } >
title: string
version: number
EntitlementCode = "omni.account_data"

Stable entitlement code granted by an agreement.

EntitlementResource { agreement_id, entitlement_code, entitlement_id, 2 more }
agreement_id: string
entitlement_code: EntitlementCode { }

Stable entitlement code granted by an agreement.

entitlement_id: string
granted_at: string
trading_account_id: number
EntitlementResourceList = Array<EntitlementResource { agreement_id, entitlement_code, entitlement_id, 2 more } >
agreement_id: string
entitlement_code: EntitlementCode { }

Stable entitlement code granted by an agreement.

entitlement_id: string
granted_at: string
trading_account_id: number
EntitlementGetEntitlementsResponse extends BaseResponse { metadata, error } { data }
data: EntitlementResourceList { agreement_id, entitlement_code, entitlement_id, 2 more }
agreement_id: string
entitlement_code: EntitlementCode { }

Stable entitlement code granted by an agreement.

entitlement_id: string
granted_at: string
trading_account_id: number
EntitlementCreateEntitlementsResponse extends BaseResponse { metadata, error } { data }
data: EntitlementResourceList { agreement_id, entitlement_code, entitlement_id, 2 more }
agreement_id: string
entitlement_code: EntitlementCode { }

Stable entitlement code granted by an agreement.

entitlement_id: string
granted_at: string
trading_account_id: number
EntitlementDeleteEntitlementResponse extends BaseResponse { metadata, error } { data }
data: DeleteEntitlementResponse { entitlement_id, revoked }
entitlement_id: string
revoked: boolean
EntitlementGetEntitlementAgreementsResponse extends BaseResponse { metadata, error } { data }
data: EntitlementAgreementResourceList { agreement_id, agreement_key, document_content, 4 more }
agreement_id: string
agreement_key: EntitlementAgreementKey { }

Stable entitlement agreement family key.

document_content: string
document_sha256: string
entitlement_codes: Array<EntitlementCode { } >
title: string
version: number