Tool Integration for VoiceBot

this documentation covers the full lifecycle of defining and deploying a tool, using the console ui for all steps i step 1 tool creation and api configuration this section focuses on defining the external api endpoint and its interface a initial tool setup navigate to tool integration from the main dashboard, select build bot > tool integration from the side menu start creation click the "create tools" button in the top right corner the "create custom api integration" panel will appear define tool metadata integration name provide a unique, non editable identifier (e g , get order status) integration description a short internal note helps ai understand when to use this integration this is the natural language prompt that guides the llm (ai) on when to execute this tool be specific (e g , "get order status") b defining the endpoint http method select the appropriate rest verb (e g , get , post, put, delete) base domain enter the root url of your api (e g , https //api example com) url path enter the specific endpoint path (e g , /order status) headers click "add header" to define key value pairs for authentication, content type, or other necessary request headers c defining tool parameters parameters define the data inputs your tool expects from the bot's conversation click "add parameter" under the parameters section key name the internal name for the variable parameter type specify where the data will be sent in the http request path data is substituted into the url path (e g , /users/{id}) query data is appended to the url as key value pairs (e g , ?city=bangalore) base type specify the expected data format string , number , boolean , or object ii step 2 testing and activating the tool a tool must pass a successful test to prove it is functional before it can be marked as active and integrated into a bot a testing the integration click the "test api integration" tab enter test data input test values for any path parameters , query parameters , or body parameters (for post/put requests) note the ui will provide a warning "test your api configuration before saving the integration a successful test is required to save " execute test click "test api" b tool status management (activation/inactivation) the tools listing shows the current status of all your integrations status display the status column shows whether a tool version is active (available for bots) or inactive (unavailable) activation/inactivation click the three dot menu ( ) next to any tool to manage its status if a tool is inactive , the menu may contain an option to mark as active (typically after a successful test) if a tool is active , the menu contains the option to mark as inactive iii step 3 integrating the tool into your bot once a tool is marked active , you can attach it to a bot and define how the conversational input maps to the tool's parameters a attaching the tool navigate to build bot (in bot editing view) scroll down to the tools section "let the agent perform specific actions " toggle switch find your active tool (e g , get order status) and toggle the switch to the on position to attach it to the bot b configuring parameter mapping after attachment, you must specify how the tool receives its input during a live conversation edit parameters click on the attached tool's name or the gear icon to open the edit parameters panel define inputs for each parameter, select the value type llm prompt the ai will use the description provided to extract the required value (e g , a city name or order id) directly from the user's utterance this is the most common choice for conversational input constant value a fixed value that is always passed to the api (e g , a static api key) dynamic variable a value retrieved from a system or user defined variable (not shown in the provided images, but an available option) save click "save" to finalize the parameter mapping iv step by step example integrating a public api this example uses a public, simple get api that requires no authentication or parameters to demonstrate the full integration workflow 1\ create the http tool go to tool integration and click "create tools" in the api configuration panel, enter the following details integration name get a random joke integration description get a random joke from a public api helps ai understand when to use this integration get a random joke http method get base domain https //official joke api appspot com/ url path /random joke headers/parameters do not add any headers or parameters as this api does not require them click the "test api integration" tab click "test api" the system will execute the get call you should see a successful 200 ok status and a json response containing the joke's setup and punchline click "save" the tool will now appear in the list with an active status 2\ integrate the tool into the bot navigate to build bot and edit an existing one or create a new bot in the bot objective, just add "to tell a joke, call the get a random joke api " scroll down to the tools section and enable the toggle switch next to the tool named get a random joke click "save" to update the bot configuration 3\ test the bot navigate to talk to bot ask the bot "can you tell me a random joke?"