public

Search Flow Classification

Changed on

Classify whether a query should be answered by search or by chat. This powers the query bar in the Onyx Search UI.

Queries longer than 200 characters are classified as a chat flow without calling an LLM. If classification fails, the endpoint falls back to is_search_flow: false rather than erroring.

post/search/search-flow-classification

Request

  • Base URL
    https://cloud.onyx.app/api
  • URL
    https://cloud.onyx.app/api/search/search-flow-classification
  • Auth
    HTTP bearer

Request body

user_querystring required

The query to classify.

Response

Successful Response

is_search_flowboolean required

True when the query looks like a search for documents, false when it should be sent to chat.

Changes