Skip to main content
POST
Get Data from Builder's Knowledge Base

Authorizations

Authorization
string
header
required

Bearer token from your account (https://agent.ai/user/integrations#api)

Body

application/json
query
string
default:{{user_input}}
required

Enter the search query to retrieve relevant knowledge base entries, such as 'best sales strategies'.

builder_knowledge_bases_list
string
required

Select which knowledge base to use for the search. For example, choose 'Product Docs' or 'Marketing Tips'.

max_documents_count
string
default:10
required

Specify the maximum number of document chunks to return, such as '5' or '10'.

score_cutoff
string
default:0.2
required

Set the score threshold for search relevance, such as '0.2' for broader results or '0.7' for more precise matches.

output_variable_name
string
default:knowledge_base_results
required

Assign a variable name to store the knowledge base results, like 'kb_results' or 'search_output'.

Pattern: ^[a-zA-Z][a-zA-Z0-9_]*$

Response

Successful response

status
integer<int32>

HTTP status code of the action response

response
object

Response data from the action