Overview

Our platform provides a comprehensive set of tools that can be integrated into your applications to enhance functionality and user experience. Tools work similarly to how they function in OpenAI's system, allowing you to make API calls with specific parameters and receive structured responses.

How Tools Work

Tools are accessed through POST requests to our API with the following components:

URL: The endpoint for the specific tool

Parameters: Required data with proper formatting and validation

Description: Details about the tool's functionality, parameter types, examples, and accepted values

API Request Structure

Tool Activation

You can use our Tool CRUD Endpoints to configure tools for your agent;

In-Built Available Tools

Available Tools Reference

Tools Overview Table

Tool Name	Tool Type	Description	Parameters	Returns/Notes
`end_call`	inline	Used to end calls, particularly when customers request callbacks. Should be called once per utterance round after collecting callback date and time.	None	Call termination
`check_month_is_future`	inline	Check if a given month and year combination is in the future compared to current date.	`date` (string): Date in YYYY-MM-DD format, uses current year and 1st of month if precise date not provided	Boolean: True if month/year is in the future, False if current
`get_per_night_price`	inline	Calculates the per-night price of a property for specified check-in and check-out dates.	`total_price` (float): Total stay price from room/property availability tools `check_in_date` (string): Check-in date in YYYY-MM-DD format `check_out_date` (string): Check-out date in YYYY-MM-DD format	Per-night price calculation
`validate_email_id`	inline	Validates customer email addresses when provided. Call this function whenever a customer provides their email address.	`email_id` (string): The email address provided by the customer	Email validation result
`date_time_is_future`	inline	Check if a given datetime is in the future compared to current date.	`checkin_date` (string): Check-in date and time in YYYY-MM-DD HH:MM format `checkout_date` (string): Check-out date and time in YYYY-MM-DD HH:MM format	Boolean validation result
`validate_phone_number_2`	inline	Validates phone numbers and corrects transcription errors that may occur during speech-to-text conversion.	`phone_number` (string): Phone number in strict digits without spaces or hyphens `utterance` (string): Customer's utterance when providing phone number, including update descriptions	Phone number validation and correction
`check_date_validity`	inline	Verifies if a check-in date is in the past when mentioned by customer.	`date_to_check` (string): Date in YYYY-MM-DD or YYYY-MM-DD HH:MM:SS format	Date validity check
`get_tellable_email`	inline	Formats email addresses in a readable way for voice confirmation with special characters spelled out.	`email` (string): The email address provided by the customer	Email formatted for voice reading
`validate_booking_date`	inline	Validates booking dates after date and month confirmation. Important: Do not verbally confirm dates are valid in response.	`checkin_date` (string): Check-in date in YYYY-MM-DD format `checkout_date` (string): Check-out date in YYYY-MM-DD format	Booking date validation (silent)
`location_helper`	inline	Assists with location collection when transcription is poor or information is missing/misinterpreted. Note: Only for location validation, not for phone numbers.	None specified	Location assistance

Parameter Format Reference

Date Formats

Standard Date: YYYY-MM-DD (e.g., 2024-03-15)

Date with Time: YYYY-MM-DD HH:MM (e.g., 2024-03-15 14:30)

Extended DateTime: YYYY-MM-DD HH:MM:SS (e.g., 2024-03-15 14:30:00)

Contact Information Formats

Email: Standard email format (e.g., user@example.com)

Phone Number: Digits only, no spaces, hyphens, or special characters (e.g., 1234567890)

Numeric Formats

Price: Float value (e.g., 150.00, 99.99)

Usage Categories

📞 Call Management

end_call

📅 Date & Time Validation

check_month_is_future

date_time_is_future

check_date_validity

validate_booking_date

💰 Pricing

get_per_night_price

📧 Contact Validation

validate_email_id

validate_phone_number_2

get_tellable_email

📍 Location Services

location_helper

Important Notes

Tool Activation: All tools require activation by our team before use

Parameter Validation: Ensure all parameters match the specified formats

Error Handling: Implement proper error handling for all tool calls

Usage Frequency: Some tools (like end_call) should only be called once per utterance round

Silent Operations: Some tools (like validate_booking_date) perform validation without requiring verbal confirmation

Important: Tools are not enabled by default. You must contact our team to activate specific tools for your account before they can be used in your applications.

Tool Activation Request

To request tool activation, contact our team with:

List of required tools out of the ones available above

Business use-case

Tools

Overview#

How Tools Work#

API Request Structure#

Tool Activation#

In-Built Available Tools#

Available Tools Reference#

Tools Overview Table#

Parameter Format Reference#

Date Formats#

Contact Information Formats#

Numeric Formats#

Usage Categories#

📞 Call Management#

📅 Date & Time Validation#

💰 Pricing#

📧 Contact Validation#

📍 Location Services#

Important Notes#

Tool Activation Request#