Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.sigmamind.ai/llms.txt

Use this file to discover all available pages before exploring further.

Tool actions define what operation the AI agent can perform using the API.
Addtool

​
Steps:

  1. Click on Add New Tool
  2. Enter the following details:
FieldDescription
Action NameName of the action (e.g., Reschedule Booking)
Description(Optional)What the action does
Endpoint URLAPI endpoint URL
Request MethodGET, POST, PUT, DELETE
HeadersRequired headers from API documentation
BodyRequest payload
Toolaction

​
Tool Name

Definition:
A unique identifier for the tool action. The agent uses this name internally to trigger the correct API call. Requirements:
  • Must be unique
  • Use snake_case format
  • No spaces allowed
Example: 
reschedule_booking

​
Description (Optional)

Definition:
Explains when and why the agent should use this action. This helps the AI understand the correct context for calling the API. Example: 
Use this action to reschedule a Cal.com booking when the user provides a new date and time.

​
HTTP / Request Method

Definition:
Specifies the type of operation to perform on the API. Supported methods:
  • GET → Retrieve data
  • POST → Create data
  • PUT → Update data
  • PATCH → Partially update data
  • DELETE → Remove data
Example: 
GET

​
Endpoint URL

Definition:
The API endpoint where the request will be sent. You can use input variables to dynamically insert values. Static example: 
https://api.cal.com/v1/bookings
Dynamic example using input variable: 
https://api.cal.com/v1/bookings/{{booking_id}}
Here, {{booking_id}} will be dynamically provided by the agent.

​
Headers

Definition:
Headers provide additional information required by the API, such as authentication and content type. Common headers example:
KeyValue
Content-Typeapplication/json
AuthorizationBearer access_token
Example configuration: 
Content-Type: application/json
Authorization: Bearer {{access_token}}

​
Query Parameters

Definition:
Query parameters allow you to filter or modify the API response. These are appended to the endpoint URL. Example configuration:
KeyValue
statusbooking_status
Final request example: 
https://api.cal.com/v1/bookings?status=upcoming

​
Request Body

Definition:
The request body contains the data sent to the API when creating or updating resources. You can use input variables to dynamically pass values.
Requestbody
Example: 
{
  "start": "{{start_time}}",
  "end": "{{end_time}}",
  "eventTypeId": "{{event_type_id}}",
  "reason": "User requested reschedule"
}

​
Input Variables (Dynamic Placeholders)

Input variables are dynamic placeholders written inside double curly braces. Format: 
{{variable_name}}
These placeholders are replaced with real values when the agent executes the API request during a conversation. The agent determines these values using:
  • User input
  • Conversation context
  • Extracted variables configured in the agent workflow
  • Agent configuration
Examples: 
{{booking_id}}
{{start_time}}
{{end_time}}
{{event_type_id}}
{{email}}
Input variables can be used in:
  • Endpoint URL
  • Query Parameters
  • Request Body

​
Complete Example: Reschedule Booking (Cal .com)

Action Name 
reschedule_booking
Method 
POST
Endpoint URL 
https://api.cal.com/v1/bookings/{{booking_id}}/reschedule
Headers 
Content-Type: application/json
Authorization: Bearer {{access_token}}

​
How Input Variables Work

​
Conversation Example:

User: I want to reschedule my appointment for tomorrow at 10 AM.

​
What SigmaMind AI does:

  1. Extracts values from conversation
  2. Maps values to variables
  3. Replaces variables in the API body
  4. Calls the API automatically

​
Final API Request Sent:

{
  "start": "2026-03-10T10:00:00Z",
  "end": "2026-03-10T10:30:00Z",
  "eventTypeId": "12345",
  "reason": "User requested reschedule"
}
  1. Click Submit Action
The action is now available for your agent.
You can add new actions to an existing integration in the App Marketplace in the same way, allowing your AI agent to perform additional operations using the connected app.

​
How to Test Tool

You can test a tool action to verify that the API works correctly before using it in your agent.
Testtool

​
Steps:

  1. Go to Tool Library from the Agent Builder
  2. Select the tool (for example, Cal.com)
  3. In the Tools section, locate the tool you want to test
  4. Click the Test button next to the action
This opens the Mock Test API screen.
  1. Enter test values for the detected input variables (such as {{start_date}}, {{end_date}}, {{event_type_id}})
  2. Click Run Test
  3. Review the response to confirm the API is working correctly
    Mocktest

​
Step 5: Use the Custom Tool in the Agent

After creating and testing your tool actions, you must add them to your agent. This allows the agent to call the tool during conversations and perform real-world operations. Method 1: Go to your Tools section
  1. Find your tool (like get_available_slots)
  2. Click Add to Agent
  3. Fill the Description
  4. Bind placeholders (if required)
  5. Then click Add to Agent

​
Method 2:

  1. Open the Agent Builder
  2. Click Add Tool
  3. Click Add Integration Tool
  4. Select the app you created or configured
  5. Select the tool you want the agent to use
  6. Click Add to Agent
Addapp

​
2. Using the API

If you prefer programmatic control, use the Integration Tools API to create a tool.

​
Field descriptions

FieldRequiredDescription
namerequiredUnique name for the tool within this integration (e.g. get-customer)
descriptionrequiredNatural language description of what the tool does — agents use this to decide when to invoke it
methodrequiredHTTP method: GET, POST, PATCH, PUT, or DELETE
urlrequiredFull endpoint URL the tool will call (e.g. https://api.stripe.com/v1/customers/{id})
queryParamsoptionalArray of query parameter definitions — each with key, value, and description
bodyParamsoptionalObject describing the request body schema — used for POST / PATCH / PUT requests
headersoptionalArray of custom headers to include with every call from this tool, each with key and value
Add New Tool
curl --request POST \
  --url https://api.sigmamind.ai/v1/integrations/{integrationId}/tools \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "name": "get-customer",
  "description": "Retrieves a customer record by ID from Stripe",
  "method": "GET",
  "url": "https://api.stripe.com/v1/customers/{customerId}",
  "queryParams": [
    {
      "key": "expand[]",
      "value": "subscriptions",
      "description": "Expand nested subscription data"
    }
  ],
  "headers": [
    {
      "key": "Stripe-Version",
      "value": "2023-10-16"
    }
  ]
}'
Example Agent Workflow
  1. User: I want to reschedule my appointment
  2. Agent collects the required information
  3. Agent calls Reschedule Booking action
  4. API processes the request
  5. Agent confirms the reschedule
Authentication failing: Verify credentials and authentication typeAPI request failing: Test API action and verify endpoint and headers

​
Best Practices

  • Always follow the API documentation of the external app
  • Use clear variable names
  • Test actions before enabling
  • Configure authentication properly
  • Use descriptive action names