Skip to main content
POST
Search Flow Classification
Required permission: Search — Read (read:search), which basic includes, so any signed-in user has it. A limited Personal Access Token needs the Search — Read scope.
A helper for query bars that offer both search and chat: it costs one small LLM call and answers whether a query reads like a document search. It is a routing hint, not a guarantee — queries over 200 characters are called a chat flow without asking the LLM at all, and a failed classification returns is_search_flow: false rather than an error.

Authorizations

Authorization
string
header
required

Authorization header with Bearer token

Body

application/json
user_query
string
required

The query to classify.

Response

Successful Response

is_search_flow
boolean
required

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