Skip to main content

Introduction to API Calling (API Tool)

1. Background​

The API Calling feature is designed to provide AskTable users with the ability to execute external tasks within a ChatBot. Through this feature, users can easily manage and call external APIs to integrate and execute various external services within the ChatBot. Whether it's booking a meeting room, corporate process approval, or reserving a hotel room, the API Calling feature makes these operations efficient and convenient.

2. Feature Introduction​

The API Calling feature allows you to define and manage external APIs for use by the ChatBot. The API Calling feature supports common HTTP request methods such as GET, POST, PUT, and DELETE, while also supporting path parameters, query parameters, and request body parameters.

Example Suppose you want to be able to directly book a meeting room within the ChatBot. You can create an API Endpoint and API Route in AskTable separately.

API Endpoint An API Endpoint represents the base URL and related configuration information of an external API. For example, the API endpoint for the meeting room reservation service might look like this:

  • Name: Meeting Room Reservation API
  • Base URL: https://api.meetingrooms.com/v1
  • Headers: {"Authorization": "Bearer yourtoken"}

API Route An API Route refers to a specific API path and method under a particular API Endpoint. For example, the API path and method for booking a meeting room might look like this:

  • Path: /rooms/{room_id}/reservations

  • Method: POST

  • Path Parameters: {'room_id': 'Meeting Room ID'}

  • Query Parameters: None

  • Request Body Parameters: {'user_id': 'User ID', 'date': 'Reservation Date', 'start_time': 'Start Time', 'end_time': 'End Time'}