Tools & Integrations
On this page
Tools & External Integrations: Giving Your Agent Agency
Unlock the full potential of your AI agent by enabling it to fetch data and take direct actions within your systems. Tools serve as the bridge between your internal infrastructure and the Nabrah platform, bringing your agent to life as a context-aware, dynamic assistant. By utilizing our no-code integration interface, you can transform your agent from a conversationalist into an operational powerhouse that interacts with your API endpoints in real-time.
Technical Requirements
To successfully integrate a tool, you must have a registered REST API ready for connection. The following technical components are required for configuration:
- HTTP Method: Clearly defined action type, typically GET (to retrieve information) or POST (to send or update data).
- Endpoint URL: The specific web address of your API.
- Timeout Settings: The maximum duration the agent should wait for your server to respond.
- Parameters:
- Headers: Necessary for authentication (e.g., API Keys) or metadata.
- Query/Body Fields: The specific data points the agent will send to your system, often mapped from the call transcript.
Strategy & Optimization
Integrating tools is a balance between functionality and performance. Because the AI must wait for your server's response before continuing the conversation, efficiency is key.
Optimization Tip: Identify the most streamlined workflow possible. Aim to minimize the frequency and complexity of API calls during a live interaction. This reduces call delays and ensures a smooth, natural conversational flow. Think of it as an optimization problem: Maximize the agent's utility while minimizing latency.
Tool Setup & Configuration
To integrate your custom API, navigate to the Tools tab on the left sidebar and click the "Create Tool" button. This will open the Basic Configuration panel, where you will define how the platform interacts with your external system.
Basic Configuration
- Name: The internal identifier for the API within the platform (e.g.,
FreeTimes). - Method: Select the HTTP action required for the call: GET, POST, PUT, DELETE, or PATCH.
- URL: The specific endpoint address for your service (e.g.,
https://api.example.com/freetimes). - Description: This is a critical field. Provide a clear explanation for the AI agent so it understands the tool's purpose and the exact scenarios in which it should be triggered.
- Timeout (seconds): This defines how long the agent will wait for your API to provide a response before giving up.
What is a Timeout? Think of this as the agent's "patience level." In voice AI, every second counts. If your API is slow and the timeout is too high, the caller will experience an awkward silence. If it's too low, the agent might stop waiting before your server finishes processing. A balanced timeout (usually 3–7 seconds) ensures the conversation stays fluid.
Parameter Configuration
Parameters are the specific pieces of data sent to your API. Click "+ Add Parameter" to define each field required by your endpoint.
Field | Requirement | Description |
Name | Mandatory | The exact key name expected by your API (e.g., |
Location | Mandatory | Where the parameter is sent: Query, Header, Body, or Path. |
Type | Mandatory | Constant: A static value you define. LLM Input: Data the agent extracts from the conversation. Variable: Metadata related to the caller (e.g., their phone number). |
Data Type | Mandatory | The format of the data: String, Number, Boolean, Array, or Object. |
Required | Optional | Check this box if the API call cannot function without this specific parameter. |
Value / Default | Optional | Used to set a fallback or static value when the type is Constant or Variable. |
Advanced: Nested Parameters (Sub-Parameters)
For complex data structures, Nabrah supports nested parameters (objects within objects). To create these, use a double underscore __ in the parameter name.
- Example: To create a
namefield inside aCallerobject, name the parameterCaller__name. - Workflow: Save the tool first after naming the parameter this way. Then, re-edit the tool; the platform will automatically recognize the double underscore and display it as a structured sub-parameter.
Linking Tools to Your Agent
Once you have successfully created and configured your tool, you must assign it to a specific agent to make it functional during a call. This step ensures that the agent has the "permission" to use that specific API endpoint when the conversation requires it.
How to Assign a Tool:
- Open Agent Editor: Navigate to your agent list and click on the agent you wish to modify to enter the Editing Tab.
- Navigate to the Tools Tab: Locate the Tools sub-tab within the agent's configuration menu.
- Select Your Tools: You will see a list of all the tools you have created. Simply check the boxes corresponding to the tools you want this specific agent to utilize.
- Save Changes: Ensure you save your agent's configuration to deploy the new capabilities.
Note: Even after adding a tool, it is best practice to mention the tool's purpose in your agent's Main Prompt. For example: "Use the FreeTimes tool to check for available appointment slots before confirming a booking with the caller."
Custom Solutions & Expert Assistance
The processes described in this documentation represent the standard, no-code methods for integrating your systems with the Nabrah platform. We understand that some business workflows require highly specialized logic, complex data transformations, or unique security protocols.
If your organization requires a custom solution or a more advanced integration than what is available through the standard interface, our engineering team is here to help. We can collaborate with you to build bespoke tools that fit your specific technological stack.
Feel free to reach out to our team for technical consultations or custom integration requests.