Deep Research

Post Deep Research

post

Handles POST requests for deep research operations based on the specified research type. Depending on the type attribute of the deep research profile, this endpoint executes different research workflows:

  • For ASSAFELOVIC_POST_RESEARCH, it gathers and processes parameters, then generates a research report.

  • For other types (ASSAFELOVIC_POST_MULTI_AGENTS, ASSAFELOVIC_POST_GENERATE_REPORT, ASSAFELOVIC_POST_MULTI_AGENTS_REPORT, DZHNG_POST_RESEARCH, SONAR_POST_RESEARCH), it returns a placeholder string.

Args: _ (User): The authenticated user, injected via dependency. request (SmartSearchDeepResearchRequest): The request payload containing research parameters. bosa_token (str): The Bosa Token.

Returns: The result of the research operation, which may be a generated report or a placeholder string depending on the research type.

Raises: May raise exceptions from downstream functions such as exec_generate_research_report.

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
  • : Read Permissions
Authorizations
OAuth2passwordRequired
Token URL:
Header parameters
bosa-tokenstringOptional
Body
querystringRequired

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

codenameany ofRequired

The codename.

stringOptional
or
nullOptional
paramsany ofOptional

Optional parameters. Defaults to empty string.

Default: ""
stringOptional
or
nullOptional
document_urlsstring[]Optional

List of documents url for additional data source for research

Default: []
bosa_tokenany ofOptional

The Bosa Token

stringOptional
or
nullOptional
Responses
chevron-right
200

Successful Response

application/json
Responseany
post
/deep-research

No content

Custom Multi Agents Research

post

Handles the custom multi-agent research process by initiating a research task and coordinating it through a smart search orchestrator.

Args: request (ResearchRequest): The incoming request containing the query for the research task.

Returns: JSONResponse: A JSON response containing the research report generated by the smart search orchestrator.

Raises: Any exceptions raised during the research task execution will propagate to the caller.

Body
querystringRequired

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

report_typestringOptional

The report type

Default: research_report
smart_llmstringOptional

The LLM model to be used for smart responses.

Default: openai:gpt-4.1
strategic_llmstringOptional

The LLM model to be used for strategic responses.

Default: openai:o4-mini
smart_token_limitintegerOptional

The token limit for smart responses.

Default: 6000
strategic_token_limitintegerOptional

The token limit for strategic responses.

Default: 4000
query_domainsstring[]Optional

The query domains to be used for the research.

Default: []
source_urlsstring[]Optional

The source urls to be used for the research.

Default: []
document_urlsstring[]Optional

The document urls to be used for the research.

Default: []
complement_source_urlsbooleanOptional

Whether to complement the source urls with the document urls.

Default: false
bosa_tokenany ofOptional

The Bosa Token

stringOptional
or
nullOptional
Responses
chevron-right
200

Successful Response

application/json
Responseany
post
/assafelovic/custom_multi_agents

No content

Last updated