CLclear-street
Omni AI

Get Threads

Changed on

List authorized conversation metadata, most recently active first (by updated_at, which a new message moves). Use page_size and page_token for pagination, and the messages endpoint for conversation history. A thread that gets a message while you page moves to the first page.

With account_id, list only conversations linked to that account and require current account access. Without it, list only conversations with no linked account.

get/v1/omni-ai/threads

Request

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

Query parameters

account_idinteger

Lists only conversations for this account, or unlinked conversations when omitted. Other reads authorize the resource's linked account. Omit when no account is selected; empty values and the string null are invalid.

page_sizeinteger

The number of items to return per page. Only used when page_token is not provided.

page_tokenstring byte

Base64URL-encoded pagination token

Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.

Response

Paginated list of thread metadata

Example response

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

Changes

  • 1bd9eddeffc8Revision 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

    • warning

      for the query request parameter account_id, the 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

    • info

      the query request parameter account_id 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