Omni AI

Get Response By ID

Changed on

Poll the current snapshot of an in-progress or completed assistant response. While its status is queued or running, content may be partial and include thinking parts. Continue polling until it becomes succeeded, failed, canceled, steered, or merged. Treat an unknown status as terminal. On steered or merged, poll GET /omni-ai/threads/{thread_id}/response at once for the response that continues the work.

Once terminal, the finalized message is available through GET /omni-ai/threads/{thread_id}/messages; refresh messages when a response ends. Authorization uses the current parent thread account, including for responses created before the account link.

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

Request

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

Path parameters

response_idstring uuid required

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.

Response

Current response snapshot with status and partial content

Example response

{
  "error": {
    "code": 400,
    "message": "Order quantity must be greater than zero"
  },
  "metadata": {
    "page_number": 1,
    "total_items": 42,
    "total_pages": 5
  },
  "data": {
    "content": {
      "parts": [
        {
          "action": {
            "prefill_order": {
              "action_type": "NEW",
              "orders": [
                {
                  "limit_price": "150.00",
                  "order_type": "LIMIT",
                  "quantity": "100",
                  "side": "BUY",
                  "symbol": "AAPL",
                  "time_in_force": "DAY"
                }
              ]
            }
          }
        }
      ]
    }
  }
}

Changes

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became optional for the status

    • warning

      added the new merged enum value to the // response property for the response status

    • warning

      added the new steered enum value to the // response property for the response status

    • breaking

      the /////////////////////// response's property type changed from object to no type for status

    • breaking

      the /////////////////////// response's property type changed from object to no type for 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

    • 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

    • 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

    • 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

    • 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

    • 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

    • 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

      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 optional property ///////////////// to the response with the status

    • info

      added the optional property ///////////////// to the response with the status

    • info

      added the optional property ///////////////// to the response with the status

    • info

      added the optional property ////////////// to the response with the status

    • info

      added the optional property ////////////// to the response with the status

    • info

      added the optional property ///////////////// to the response with the status

    • info

      added the optional property /////////////// to the response with the status

    • info

      added the optional property ///////////////// to the response with the status

    • info

      added the optional property /////////////// to the response with the status

    • info

      added subschema #1 subschema #2 to the /////////////////////// response property allOf list for the response status

    • info

      added subschema #1 subschema #2 to the /////////////////////// response property allOf list for the response status

    • info

      added subschema #1 subschema #2 to the /////////////////////// response property allOf list for the response status

    • info

      removed subschema #1 subschema #2 from the /////////////////////// response property allOf list for the response 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

    • 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