> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.itspropel.com/llms.txt. > For full documentation content, see https://docs.itspropel.com/llms-full.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.itspropel.com/_mcp/server. # Search Knowledge Base POST https://knowledge-base/search Content-Type: multipart/form-data Reference: https://docs.itspropel.com/propel-biz/28-knowledge-base/search/search-knowledge-base ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: PropelBiz version: 1.0.0 paths: /knowledge-base/search: post: operationId: search-knowledge-base summary: Search Knowledge Base tags: - subpackage_28KnowledgeBase.subpackage_28KnowledgeBase/search parameters: - name: '{{tenant_key_name}}' in: header required: false schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: >- #/components/schemas/28 Knowledge Base_Search_Search Knowledge Base_Response_200 requestBody: content: multipart/form-data: schema: type: object properties: query: type: string description: >- Required (if no audio): Search query text - string, max 1000 chars no_cache: type: string description: 'Optional: Bypass cache - true|false' article_type: type: string description: >- Optional: Filter by article type - troubleshooting|parts_reference|installation_guide|safety_procedure equipment_id: type: string description: 'Optional: Equipment UUID to enrich context' document_type: type: string description: 'Optional: Filter by source type - article|document' kb_category_id: type: string description: 'Optional: Category UUID to filter results' conversation_id: type: string description: 'Optional: Conversation UUID for multi-turn context' response_format: type: string description: 'Optional: Response format - text|audio|both' required: - query - no_cache - article_type - equipment_id - document_type - kb_category_id - conversation_id - response_format servers: - url: https:/ components: schemas: 28 Knowledge Base_Search_Search Knowledge Base_Response_200: type: object properties: {} description: Empty response body title: 28 Knowledge Base_Search_Search Knowledge Base_Response_200 ``` ## SDK Code Examples ```python import requests url = "https://https/knowledge-base/search" payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"query\"\r\n\r\nHow to reset the conveyor belt motor?\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"no_cache\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"article_type\"\r\n\r\ntroubleshooting\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"equipment_id\"\r\n\r\na3f1c9d2-4b7e-11ec-81d3-0242ac130003\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document_type\"\r\n\r\narticle\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"kb_category_id\"\r\n\r\nb7e23f2e-4b7e-11ec-81d3-0242ac130003\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"conversation_id\"\r\n\r\nd9f1a3b4-4b7e-11ec-81d3-0242ac130003\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"response_format\"\r\n\r\ntext\r\n-----011000010111000001101001--\r\n" headers = { "{{tenant_key_name}}": "{{tenant_key_value1}}|{{tenant_key_value2}}", "Content-Type": "multipart/form-data; boundary=---011000010111000001101001" } response = requests.post(url, data=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://https/knowledge-base/search'; const form = new FormData(); form.append('query', 'How to reset the conveyor belt motor?'); form.append('no_cache', 'false'); form.append('article_type', 'troubleshooting'); form.append('equipment_id', 'a3f1c9d2-4b7e-11ec-81d3-0242ac130003'); form.append('document_type', 'article'); form.append('kb_category_id', 'b7e23f2e-4b7e-11ec-81d3-0242ac130003'); form.append('conversation_id', 'd9f1a3b4-4b7e-11ec-81d3-0242ac130003'); form.append('response_format', 'text'); const options = { method: 'POST', headers: {'{{tenant_key_name}}': '{{tenant_key_value1}}|{{tenant_key_value2}}'} }; options.body = form; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://https/knowledge-base/search" payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"query\"\r\n\r\nHow to reset the conveyor belt motor?\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"no_cache\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"article_type\"\r\n\r\ntroubleshooting\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"equipment_id\"\r\n\r\na3f1c9d2-4b7e-11ec-81d3-0242ac130003\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document_type\"\r\n\r\narticle\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"kb_category_id\"\r\n\r\nb7e23f2e-4b7e-11ec-81d3-0242ac130003\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"conversation_id\"\r\n\r\nd9f1a3b4-4b7e-11ec-81d3-0242ac130003\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"response_format\"\r\n\r\ntext\r\n-----011000010111000001101001--\r\n") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("{{tenant_key_name}}", "{{tenant_key_value1}}|{{tenant_key_value2}}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://https/knowledge-base/search") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["{{tenant_key_name}}"] = '{{tenant_key_value1}}|{{tenant_key_value2}}' request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"query\"\r\n\r\nHow to reset the conveyor belt motor?\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"no_cache\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"article_type\"\r\n\r\ntroubleshooting\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"equipment_id\"\r\n\r\na3f1c9d2-4b7e-11ec-81d3-0242ac130003\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document_type\"\r\n\r\narticle\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"kb_category_id\"\r\n\r\nb7e23f2e-4b7e-11ec-81d3-0242ac130003\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"conversation_id\"\r\n\r\nd9f1a3b4-4b7e-11ec-81d3-0242ac130003\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"response_format\"\r\n\r\ntext\r\n-----011000010111000001101001--\r\n" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://https/knowledge-base/search") .header("{{tenant_key_name}}", "{{tenant_key_value1}}|{{tenant_key_value2}}") .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"query\"\r\n\r\nHow to reset the conveyor belt motor?\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"no_cache\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"article_type\"\r\n\r\ntroubleshooting\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"equipment_id\"\r\n\r\na3f1c9d2-4b7e-11ec-81d3-0242ac130003\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document_type\"\r\n\r\narticle\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"kb_category_id\"\r\n\r\nb7e23f2e-4b7e-11ec-81d3-0242ac130003\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"conversation_id\"\r\n\r\nd9f1a3b4-4b7e-11ec-81d3-0242ac130003\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"response_format\"\r\n\r\ntext\r\n-----011000010111000001101001--\r\n") .asString(); ``` ```php request('POST', 'https://https/knowledge-base/search', [ 'multipart' => [ [ 'name' => 'query', 'contents' => 'How to reset the conveyor belt motor?' ], [ 'name' => 'no_cache', 'contents' => 'false' ], [ 'name' => 'article_type', 'contents' => 'troubleshooting' ], [ 'name' => 'equipment_id', 'contents' => 'a3f1c9d2-4b7e-11ec-81d3-0242ac130003' ], [ 'name' => 'document_type', 'contents' => 'article' ], [ 'name' => 'kb_category_id', 'contents' => 'b7e23f2e-4b7e-11ec-81d3-0242ac130003' ], [ 'name' => 'conversation_id', 'contents' => 'd9f1a3b4-4b7e-11ec-81d3-0242ac130003' ], [ 'name' => 'response_format', 'contents' => 'text' ] ] 'headers' => [ '{{tenant_key_name}}' => '{{tenant_key_value1}}|{{tenant_key_value2}}', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://https/knowledge-base/search"); var request = new RestRequest(Method.POST); request.AddHeader("{{tenant_key_name}}", "{{tenant_key_value1}}|{{tenant_key_value2}}"); request.AddParameter("undefined", "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"query\"\r\n\r\nHow to reset the conveyor belt motor?\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"no_cache\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"article_type\"\r\n\r\ntroubleshooting\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"equipment_id\"\r\n\r\na3f1c9d2-4b7e-11ec-81d3-0242ac130003\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document_type\"\r\n\r\narticle\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"kb_category_id\"\r\n\r\nb7e23f2e-4b7e-11ec-81d3-0242ac130003\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"conversation_id\"\r\n\r\nd9f1a3b4-4b7e-11ec-81d3-0242ac130003\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"response_format\"\r\n\r\ntext\r\n-----011000010111000001101001--\r\n", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["{{tenant_key_name}}": "{{tenant_key_value1}}|{{tenant_key_value2}}"] let parameters = [ [ "name": "query", "value": "How to reset the conveyor belt motor?" ], [ "name": "no_cache", "value": "false" ], [ "name": "article_type", "value": "troubleshooting" ], [ "name": "equipment_id", "value": "a3f1c9d2-4b7e-11ec-81d3-0242ac130003" ], [ "name": "document_type", "value": "article" ], [ "name": "kb_category_id", "value": "b7e23f2e-4b7e-11ec-81d3-0242ac130003" ], [ "name": "conversation_id", "value": "d9f1a3b4-4b7e-11ec-81d3-0242ac130003" ], [ "name": "response_format", "value": "text" ] ] let boundary = "---011000010111000001101001" var body = "" var error: NSError? = nil for param in parameters { let paramName = param["name"]! body += "--\(boundary)\r\n" body += "Content-Disposition:form-data; name=\"\(paramName)\"" if let filename = param["fileName"] { let contentType = param["content-type"]! let fileContent = String(contentsOfFile: filename, encoding: String.Encoding.utf8) if (error != nil) { print(error as Any) } body += "; filename=\"\(filename)\"\r\n" body += "Content-Type: \(contentType)\r\n\r\n" body += fileContent } else if let paramValue = param["value"] { body += "\r\n\r\n\(paramValue)" } } let request = NSMutableURLRequest(url: NSURL(string: "https://https/knowledge-base/search")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```