1"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[15403],{8667:(e,r,s)=>{s.d(r,{R:()=>i,x:()=>l});var n=s(22155);const t={},o=n.createContext(t);function i(e){const r=n.useContext(o);return n.useMemo(function(){return"function"==typeof e?e(r):{...r,...e}},[r,e])}function l(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:i(e.components),n.createElement(o.Provider,{value:r},e.children)}},77499:(e,r,s)=>{s.r(r),s.d(r,{assets:()=>a,contentTitle:()=>l,default:()=>d,frontMatter:()=>i,metadata:()=>n,toc:()=>c});const n=JSON.parse('{"id":"sidekick-studio/chatflows/tools/bravesearch-api","title":"BraveSearch API Tool","description":"Access Brave search results in real-time with the BraveSearch API Tool","source":"@site/docs/sidekick-studio/chatflows/tools/bravesearch-api.md","sourceDirName":"sidekick-studio/chatflows/tools","slug":"/sidekick-studio/chatflows/tools/bravesearch-api","permalink":"/docs/sidekick-studio/chatflows/tools/bravesearch-api","draft":false,"unlisted":false,"tags":[],"version":"current","frontMatter":{"description":"Access Brave search results in real-time with the BraveSearch API Tool"},"sidebar":"docs","previous":{"title":"Tools","permalink":"/docs/sidekick-studio/chatflows/tools/"},"next":{"title":"Calculator Tool","permalink":"/docs/sidekick-studio/chatflows/tools/calculator"}}');var t=s(65723),o=s(8667);const i={description:"Access Brave search results in real-time with the BraveSearch API Tool"},l="BraveSearch API Tool",a={},c=[{value:"Overview",id:"overview",level:2},{value:"Key Benefits",id:"key-benefits",level:2},{value:"How to Use",id:"how-to-use",level:2},{value:"Tips and Best Practices",id:"tips-and-best-practices",level:2},{value:"Troubleshooting",id:"troubleshooting",level:2}];function h(e){const r={h1:"h1",h2:"h2",header:"header",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(r.header,{children:(0,t.jsx)(r.h1,{id:"bravesearch-api-tool",children:"BraveSearch API Tool"})}),"\n",(0,t.jsx)(r.h2,{id:"overview",children:"Overview"}),"\n",(0,t.jsx)(r.p,{children:"The BraveSearch API Tool allows you to integrate Brave's search capabilities into your AnswerAgentAI workflows. This tool provides real-time access to Brave search results, enabling you to retrieve up-to-date information on various topics directly within your projects."}),"\n",(0,t.jsx)(r.h2,{id:"key-benefits",children:"Key Benefits"}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsx)(r.li,{children:"Access to current and relevant search results from Brave"}),"\n",(0,t.jsx)(r.li,{children:"Easy integration with AnswerAgentAI workflows"}),"\n",(0,t.jsx)(r.li,{children:"Real-time information retrieval for enhanced decision-making"}),"\n"]}),"\n",(0,t.jsx)(r.h2,{id:"how-to-use",children:"How to Use"}),"\n",(0,t.jsxs)(r.ol,{children:["\n",(0,t.jsx)(r.li,{children:"Add the BraveSearch API Tool to your canvas in the AnswerAgentAI Studio."}),"\n"]}),"\n",(0,t.jsxs)("figure",{children:[(0,t.jsx)("img",{src:"/.gitbook/assets/screenshots/braveapi.png",alt:""}),(0,t.jsx)("figcaption",{children:(0,t.jsx)("p",{children:"BraveSearch API Tool & Drop UI"})})]}),"\n",(0,t.jsxs)(r.ol,{start:"2",children:["\n",(0,t.jsxs)(r.li,{children:["Connect your Brave Search API credential:","\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsx)(r.li,{children:"Click on the BraveSearch API Tool node"}),"\n",(0,t.jsx)(r.li,{children:'In the right sidebar, click on "Add New Credential"'}),"\n",(0,t.jsx)(r.li,{children:'Select "BraveSearch API" from the dropdown'}),"\n",(0,t.jsx)(r.li,{children:"Enter your Brave Search API key"}),"\n",(0,t.jsx)(r.li,{children:'Click "Save" to store your credential'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,t.jsxs)("figure",{children:[(0,t.jsx)("img",{src:"/.gitbook/assets/screenshots/bravesearchapi.png",alt:""}),(0,t.jsx)("figcaption",{children:(0,t.jsx)("p",{children:"BraveSearch API Credentials & Drop UI"})})]}),"\n",(0,t.jsxs)(r.ol,{start:"3",children:["\n",(0,t.jsxs)(r.li,{children:["\n",(0,t.jsx)(r.p,{children:"The BraveSearch API Tool is now ready to use in your workflow. You can connect it to other nodes that require search functionality or real-time information."}),"\n"]}),"\n",(0,t.jsxs)(r.li,{children:["\n",(0,t.jsx)(r.p,{children:"To use the tool in your workflow, simply pass a search query as input to the BraveSearch API Tool node. The tool will return search results in JSON format."}),"\n"]}),"\n"]}),"\n",(0,t.jsx)(r.h2,{id:"tips-and-best-practices",children:"Tips and Best Practices"}),"\n",(0,t.jsxs)(r.ol,{children:["\n",(0,t.jsx)(r.li,{children:"Use specific and targeted search queries to get the most relevant results."}),"\n",(0,t.jsx)(r.li,{children:"Consider combining the BraveSearch API Tool with other nodes to process and analyze the search results further."}),"\n",(0,t.jsx)(r.li,{children:"Be mindful of API usage limits and implement appropriate error handling in y
1our workflows."}),"\n"]}),"\n",(0,t.jsx)(r.h2,{id:"troubleshooting",children:"Troubleshooting"}),"\n",(0,t.jsxs)(r.ol,{children:["\n",(0,t.jsxs)(r.li,{children:["\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.strong,{children:"API Key Issues"}),": If you encounter authentication errors, double-check that you've entered the correct Brave Search API key in your credential settings."]}),"\n"]}),"\n",(0,t.jsxs)(r.li,{children:["\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.strong,{children:"No Results"}),": If your search query returns no results, try broadening your search terms or check if the topic is too recent or obscure."]}),"\n"]}),"\n",(0,t.jsxs)(r.li,{children:["\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.strong,{children:"Rate Limiting"}),": If you experience rate limiting issues, consider implementing a delay between requests or optimizing your workflow to reduce the number of API calls."]}),"\n"]}),"\n"]}),"\n",(0,t.jsx)(r.p,{children:"Remember that the BraveSearch API Tool is particularly useful for retrieving current information and can be a valuable asset in workflows that require up-to-date data from the web."})]})}function d(e={}){const{wrapper:r}={...(0,o.R)(),...e.components};return r?(0,t.jsx)(r,{...e,children:(0,t.jsx)(h,{...e})}):h(e)}}}]);
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.