Default

Get Search

get

Endpoint for executing a deep search without browsing.

This function authenticates the user, triggers a deep search based on the provided query, and returns simplified metadata (title, source, body) from the results.

Args: request (SmartSearchGetSearchRequest): The form-based request containing token and query data.

Returns: JSONResponse: A list of search results with keys: "title", "href", and "body".

Raises: HTTPException: If the user is unauthorized or lacks the required "read:all" scope.

Notes: - The request must include a valid token with the "read:all" scope. - This function uses FastAPI's dependency injection to handle form parsing and token validation.

Query parameters

querystringRequired

The search query string that specifies the information to be retrieved.

sstany ofOptional

The Smart Search Token

Default: ""

stringOptional

or

nullOptional

Header parameters

bosa-tokenany ofOptional

stringOptional

or

nullOptional

Body

application/x-www-form-urlencoded

bosa_tokenany ofOptional

The Bosa Token

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/search

HTTPcURLJavaScriptPython

GET /search?query=text HTTP/1.1
Host: 
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 21

"bosa_token='text'"

No content