Omni AI

Atomically create a conversation and submit its first user turn. Use instant with text for a prompt, or deep_insights with a ticker target and optional thesis for long-form research.

Poll the returned response_id via GET /omni-ai/responses/{response_id} for assistant output.

Omit account_id to start without an account. The first accepted turn with a selected account links that account permanently. Reuse Idempotency-Key only for an identical request.

post/v1/omni-ai/threads

Request

  • Base URL
    https://api.clearstreet.com
  • Auth
    HTTP bearer

Request body

account_idinteger nullable

Selected account for creation or the first account-linked turn. Omit for an unlinked conversation. An existing account link remains authoritative even when another account is selected.

capabilitiesCapability[]
textstring nullable
thesisstring nullable
type'instant' | 'deep_insights' required

Thread creation mode.

Example request

{
  "account_id": 19816,
  "text": "What changed in NVDA today?",
  "type": "instant"
}

Response

Thread created. Poll the returned response_id for assistant output.

Example response

{
  "error": {
    "code": 400,
    "message": "Order quantity must be greater than zero"
  },
  "metadata": {
    "page_number": 1,
    "total_items": 42,
    "total_pages": 5
  }
}

Changes

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • warning

      the request property's min was set to 1.00

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the new optional request property

    • info

      the request property became nullable

    • info

      the request property became optional

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status