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": "Fetches a Shopify customer record by customer ID. Call this tool when you need to look up customer details such as name, email, or order history.",
"method": "GET",
"url": "https://my-store.myshopify.com/admin/api/2024-01/customers/{{customerId}}.json",
"headers": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"queryParams": [
{
"key": "status",
"value": "{{status}}"
}
],
"bodyParams": {
"first_name": "{{firstName}}",
"email": "{{email}}"
}
}
'import requests
url = "https://api.sigmamind.ai/v1/integrations/{integrationId}/tools"
payload = {
"name": "get_customer",
"description": "Fetches a Shopify customer record by customer ID. Call this tool when you need to look up customer details such as name, email, or order history.",
"method": "GET",
"url": "https://my-store.myshopify.com/admin/api/2024-01/customers/{{customerId}}.json",
"headers": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"queryParams": [
{
"key": "status",
"value": "{{status}}"
}
],
"bodyParams": {
"first_name": "{{firstName}}",
"email": "{{email}}"
}
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'get_customer',
description: 'Fetches a Shopify customer record by customer ID. Call this tool when you need to look up customer details such as name, email, or order history.',
method: 'GET',
url: 'https://my-store.myshopify.com/admin/api/2024-01/customers/{{customerId}}.json',
headers: [{key: 'Content-Type', value: 'application/json'}],
queryParams: [{key: 'status', value: '{{status}}'}],
bodyParams: {first_name: '{{firstName}}', email: '{{email}}'}
})
};
fetch('https://api.sigmamind.ai/v1/integrations/{integrationId}/tools', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sigmamind.ai/v1/integrations/{integrationId}/tools",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'get_customer',
'description' => 'Fetches a Shopify customer record by customer ID. Call this tool when you need to look up customer details such as name, email, or order history.',
'method' => 'GET',
'url' => 'https://my-store.myshopify.com/admin/api/2024-01/customers/{{customerId}}.json',
'headers' => [
[
'key' => 'Content-Type',
'value' => 'application/json'
]
],
'queryParams' => [
[
'key' => 'status',
'value' => '{{status}}'
]
],
'bodyParams' => [
'first_name' => '{{firstName}}',
'email' => '{{email}}'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sigmamind.ai/v1/integrations/{integrationId}/tools"
payload := strings.NewReader("{\n \"name\": \"get_customer\",\n \"description\": \"Fetches a Shopify customer record by customer ID. Call this tool when you need to look up customer details such as name, email, or order history.\",\n \"method\": \"GET\",\n \"url\": \"https://my-store.myshopify.com/admin/api/2024-01/customers/{{customerId}}.json\",\n \"headers\": [\n {\n \"key\": \"Content-Type\",\n \"value\": \"application/json\"\n }\n ],\n \"queryParams\": [\n {\n \"key\": \"status\",\n \"value\": \"{{status}}\"\n }\n ],\n \"bodyParams\": {\n \"first_name\": \"{{firstName}}\",\n \"email\": \"{{email}}\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.sigmamind.ai/v1/integrations/{integrationId}/tools")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"get_customer\",\n \"description\": \"Fetches a Shopify customer record by customer ID. Call this tool when you need to look up customer details such as name, email, or order history.\",\n \"method\": \"GET\",\n \"url\": \"https://my-store.myshopify.com/admin/api/2024-01/customers/{{customerId}}.json\",\n \"headers\": [\n {\n \"key\": \"Content-Type\",\n \"value\": \"application/json\"\n }\n ],\n \"queryParams\": [\n {\n \"key\": \"status\",\n \"value\": \"{{status}}\"\n }\n ],\n \"bodyParams\": {\n \"first_name\": \"{{firstName}}\",\n \"email\": \"{{email}}\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sigmamind.ai/v1/integrations/{integrationId}/tools")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"get_customer\",\n \"description\": \"Fetches a Shopify customer record by customer ID. Call this tool when you need to look up customer details such as name, email, or order history.\",\n \"method\": \"GET\",\n \"url\": \"https://my-store.myshopify.com/admin/api/2024-01/customers/{{customerId}}.json\",\n \"headers\": [\n {\n \"key\": \"Content-Type\",\n \"value\": \"application/json\"\n }\n ],\n \"queryParams\": [\n {\n \"key\": \"status\",\n \"value\": \"{{status}}\"\n }\n ],\n \"bodyParams\": {\n \"first_name\": \"{{firstName}}\",\n \"email\": \"{{email}}\"\n }\n}"
response = http.request(request)
puts response.read_body{
"toolId": "tool_X9pLm2Wq8Rt3",
"integrationId": "intg_AuUKK371Spr5",
"name": "get_order_details",
"description": "Fetches order details from Shopify by order ID. Call this tool when you need to retrieve order status, line items, or shipping info.",
"method": "GET",
"url": "https://my-store.myshopify.com/admin/api/2024-01/orders/{{orderId}}.json",
"scope": "local",
"headers": {
"customer_name": "Michael",
"account_id": "ACC-001"
},
"queryParams": {
"customer_name": "Michael",
"account_id": "ACC-001"
},
"bodyParams": {
"customer_name": "Michael",
"account_id": "ACC-001"
},
"createdAt": "2024-04-20T10:00:00.000Z",
"updatedAt": "2024-04-21T08:30:00.000Z"
}{
"error": "Bad Request",
"message": "Invalid request parameters",
"path": "/v1/integrations/{integrationId}/tools",
"status": 400,
"timestamp": "2026-05-05T10:06:45.788Z"
}{
"error": "Unauthorized",
"message": "X-API-Key is missing or invalid",
"path": "/v1/integrations/{integrationId}/tools",
"status": 401,
"timestamp": "2026-05-05T10:06:45.788Z"
}{
"error": "Forbidden",
"message": "Access denied for this resource",
"path": "/v1/integrations/{integrationId}/tools",
"status": 403,
"timestamp": "2026-05-05T10:06:45.788Z"
}{
"error": "Not Found",
"message": "The requested resource was not found",
"path": "/v1/integrations/{integrationId}/tools",
"status": 404,
"timestamp": "2026-05-05T10:06:45.788Z"
}{
"error": "Internal Server Error",
"message": "Unexpected server error",
"path": "/v1/integrations/{integrationId}/tools",
"status": 500,
"timestamp": "2026-05-05T10:06:45.788Z"
}Create Tool
Creates a new API tool under the specified integration. Define the HTTP endpoint, method, and parameter schema the agent will use when invoking the tool. Returns the created tool including its toolId, which is required for subsequent get, update, delete, and execute calls.
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": "Fetches a Shopify customer record by customer ID. Call this tool when you need to look up customer details such as name, email, or order history.",
"method": "GET",
"url": "https://my-store.myshopify.com/admin/api/2024-01/customers/{{customerId}}.json",
"headers": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"queryParams": [
{
"key": "status",
"value": "{{status}}"
}
],
"bodyParams": {
"first_name": "{{firstName}}",
"email": "{{email}}"
}
}
'import requests
url = "https://api.sigmamind.ai/v1/integrations/{integrationId}/tools"
payload = {
"name": "get_customer",
"description": "Fetches a Shopify customer record by customer ID. Call this tool when you need to look up customer details such as name, email, or order history.",
"method": "GET",
"url": "https://my-store.myshopify.com/admin/api/2024-01/customers/{{customerId}}.json",
"headers": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"queryParams": [
{
"key": "status",
"value": "{{status}}"
}
],
"bodyParams": {
"first_name": "{{firstName}}",
"email": "{{email}}"
}
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'get_customer',
description: 'Fetches a Shopify customer record by customer ID. Call this tool when you need to look up customer details such as name, email, or order history.',
method: 'GET',
url: 'https://my-store.myshopify.com/admin/api/2024-01/customers/{{customerId}}.json',
headers: [{key: 'Content-Type', value: 'application/json'}],
queryParams: [{key: 'status', value: '{{status}}'}],
bodyParams: {first_name: '{{firstName}}', email: '{{email}}'}
})
};
fetch('https://api.sigmamind.ai/v1/integrations/{integrationId}/tools', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sigmamind.ai/v1/integrations/{integrationId}/tools",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'get_customer',
'description' => 'Fetches a Shopify customer record by customer ID. Call this tool when you need to look up customer details such as name, email, or order history.',
'method' => 'GET',
'url' => 'https://my-store.myshopify.com/admin/api/2024-01/customers/{{customerId}}.json',
'headers' => [
[
'key' => 'Content-Type',
'value' => 'application/json'
]
],
'queryParams' => [
[
'key' => 'status',
'value' => '{{status}}'
]
],
'bodyParams' => [
'first_name' => '{{firstName}}',
'email' => '{{email}}'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sigmamind.ai/v1/integrations/{integrationId}/tools"
payload := strings.NewReader("{\n \"name\": \"get_customer\",\n \"description\": \"Fetches a Shopify customer record by customer ID. Call this tool when you need to look up customer details such as name, email, or order history.\",\n \"method\": \"GET\",\n \"url\": \"https://my-store.myshopify.com/admin/api/2024-01/customers/{{customerId}}.json\",\n \"headers\": [\n {\n \"key\": \"Content-Type\",\n \"value\": \"application/json\"\n }\n ],\n \"queryParams\": [\n {\n \"key\": \"status\",\n \"value\": \"{{status}}\"\n }\n ],\n \"bodyParams\": {\n \"first_name\": \"{{firstName}}\",\n \"email\": \"{{email}}\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.sigmamind.ai/v1/integrations/{integrationId}/tools")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"get_customer\",\n \"description\": \"Fetches a Shopify customer record by customer ID. Call this tool when you need to look up customer details such as name, email, or order history.\",\n \"method\": \"GET\",\n \"url\": \"https://my-store.myshopify.com/admin/api/2024-01/customers/{{customerId}}.json\",\n \"headers\": [\n {\n \"key\": \"Content-Type\",\n \"value\": \"application/json\"\n }\n ],\n \"queryParams\": [\n {\n \"key\": \"status\",\n \"value\": \"{{status}}\"\n }\n ],\n \"bodyParams\": {\n \"first_name\": \"{{firstName}}\",\n \"email\": \"{{email}}\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sigmamind.ai/v1/integrations/{integrationId}/tools")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"get_customer\",\n \"description\": \"Fetches a Shopify customer record by customer ID. Call this tool when you need to look up customer details such as name, email, or order history.\",\n \"method\": \"GET\",\n \"url\": \"https://my-store.myshopify.com/admin/api/2024-01/customers/{{customerId}}.json\",\n \"headers\": [\n {\n \"key\": \"Content-Type\",\n \"value\": \"application/json\"\n }\n ],\n \"queryParams\": [\n {\n \"key\": \"status\",\n \"value\": \"{{status}}\"\n }\n ],\n \"bodyParams\": {\n \"first_name\": \"{{firstName}}\",\n \"email\": \"{{email}}\"\n }\n}"
response = http.request(request)
puts response.read_body{
"toolId": "tool_X9pLm2Wq8Rt3",
"integrationId": "intg_AuUKK371Spr5",
"name": "get_order_details",
"description": "Fetches order details from Shopify by order ID. Call this tool when you need to retrieve order status, line items, or shipping info.",
"method": "GET",
"url": "https://my-store.myshopify.com/admin/api/2024-01/orders/{{orderId}}.json",
"scope": "local",
"headers": {
"customer_name": "Michael",
"account_id": "ACC-001"
},
"queryParams": {
"customer_name": "Michael",
"account_id": "ACC-001"
},
"bodyParams": {
"customer_name": "Michael",
"account_id": "ACC-001"
},
"createdAt": "2024-04-20T10:00:00.000Z",
"updatedAt": "2024-04-21T08:30:00.000Z"
}{
"error": "Bad Request",
"message": "Invalid request parameters",
"path": "/v1/integrations/{integrationId}/tools",
"status": 400,
"timestamp": "2026-05-05T10:06:45.788Z"
}{
"error": "Unauthorized",
"message": "X-API-Key is missing or invalid",
"path": "/v1/integrations/{integrationId}/tools",
"status": 401,
"timestamp": "2026-05-05T10:06:45.788Z"
}{
"error": "Forbidden",
"message": "Access denied for this resource",
"path": "/v1/integrations/{integrationId}/tools",
"status": 403,
"timestamp": "2026-05-05T10:06:45.788Z"
}{
"error": "Not Found",
"message": "The requested resource was not found",
"path": "/v1/integrations/{integrationId}/tools",
"status": 404,
"timestamp": "2026-05-05T10:06:45.788Z"
}{
"error": "Internal Server Error",
"message": "Unexpected server error",
"path": "/v1/integrations/{integrationId}/tools",
"status": 500,
"timestamp": "2026-05-05T10:06:45.788Z"
}Authorizations
Authenticate every request by passing your API key in the X-API-Key header. To get your key, go to Dashboard → API Keys and create or copy your Production API key.
Path Parameters
Unique identifier of the integration to create the tool under.
Body
Request body to create a new API tool under an integration. A tool represents a single callable API operation — for example 'get_customer' or 'create_order' — that an AI agent can invoke at runtime. Dynamic values are declared using {{variable}} placeholders in the URL, headers, query params, or body; the agent resolves these at invocation time.
Action-oriented, snake_case name that uniquely identifies this tool within the integration. AI agents use this name to select the correct tool when deciding which operation to invoke. Must be unique within the integration. Good examples: 'get_customer', 'create_order', 'cancel_subscription'.
128"get_customer"
Explanation of what this tool does and the exact conditions under which an AI agent should invoke it. Agents rely on this description to match a task to the correct tool — be specific about the action, the resource it operates on, and any inputs the agent must supply.
1024"Fetches a Shopify customer record by customer ID. Call this tool when you need to look up customer details such as name, email, or order history."
HTTP method used when invoking this tool's endpoint. GET retrieves a resource without side effects. POST creates a new resource. PUT fully replaces an existing resource. PATCH partially updates an existing resource. DELETE removes a resource.
GET, POST, PUT, PATCH, DELETE "GET"
Full URL of the API endpoint this tool calls. Supports {{variable}} placeholders for path segments the agent resolves at runtime (e.g., {{customerId}} in the path). Path variables embedded here do not need to be redeclared in queryParams.
1024"https://my-store.myshopify.com/admin/api/2024-01/customers/{{customerId}}.json"
Static HTTP headers sent on every request made by this tool. Merged with headers defined at the integration and auth levels; tool-level headers take precedence on key conflicts. Values may contain {{variable}} placeholders resolved by the agent at runtime. Leave empty if no tool-specific headers are needed.
Show child attributes
Show child attributes
[
{
"key": "Content-Type",
"value": "application/json"
}
]
Query string parameters appended to the URL on every invocation (e.g., ?status=active&limit=10). Values support {{variable}} placeholders so the agent can supply them at runtime. Path variables already embedded in the URL using {{variable}} syntax do not need to be listed here.
Show child attributes
Show child attributes
[{ "key": "status", "value": "{{status}}" }]
Request body payload sent when this tool is invoked, as a JSON object. Values support {{variable}} placeholders that the agent resolves at runtime. Provide only for POST, PUT, and PATCH tools. Leave empty or omit for GET and DELETE — body content is ignored for those methods.
Show child attributes
Show child attributes
{
"first_name": "{{firstName}}",
"email": "{{email}}"
}
Response
Created
Represents a single callable API tool registered under an integration. Each tool maps to one specific API operation (e.g., 'Get Order', 'Create Customer') and carries its full invocation config: HTTP method, endpoint URL, headers, and parameters. AI agents use this response to understand what the tool does and how to invoke it.
Unique identifier for this tool. Use this value as toolId when executing, updating, or deleting this tool.
"tool_X9pLm2Wq8Rt3"
Unique identifier of the integration this tool belongs to. Use this value as integrationId when making requests scoped to the parent integration.
"intg_AuUKK371Spr5"
Action-oriented name for this tool that identifies the operation it performs. AI agents use this name to match a task to the correct tool. Follows snake_case convention (e.g., 'get_customer', 'create_order').
"get_order_details"
Explanation of what this tool does and when an AI agent should invoke it. Agents rely on this description to decide whether this tool matches the current task. A good description names the action, the resource it operates on, and required inputs.
"Fetches order details from Shopify by order ID. Call this tool when you need to retrieve order status, line items, or shipping info."
HTTP method used when invoking this tool's endpoint. GET retrieves a resource without side effects. POST creates a new resource. PUT fully replaces an existing resource. PATCH partially updates an existing resource. DELETE removes a resource.
GET, POST, PUT, PATCH, DELETE "GET"
Full URL of the API endpoint this tool calls, including any {{variable}} placeholders that the agent resolves at runtime using the declared parameters. Path segments wrapped in {{}} (e.g., {{orderId}}) are substituted before the request is sent.
"https://my-store.myshopify.com/admin/api/2024-01/orders/{{orderId}}.json"
Visibility scope of this tool. 'local' means the tool is private to your account and only accessible within your integrations. 'community' means the tool is shared and discoverable by other users.
local, community "local"
Dynamic key-value pairs that were passed to the agent at call start for personalisation. Keys correspond to variable names defined in the agent's configuration (e.g., 'customer_name', 'account_id'). Null or empty if no dynamic variables were provided when the call was created.
{
"customer_name": "Michael",
"account_id": "ACC-001"
}
Dynamic key-value pairs that were passed to the agent at call start for personalisation. Keys correspond to variable names defined in the agent's configuration (e.g., 'customer_name', 'account_id'). Null or empty if no dynamic variables were provided when the call was created.
{
"customer_name": "Michael",
"account_id": "ACC-001"
}
Dynamic key-value pairs that were passed to the agent at call start for personalisation. Keys correspond to variable names defined in the agent's configuration (e.g., 'customer_name', 'account_id'). Null or empty if no dynamic variables were provided when the call was created.
{
"customer_name": "Michael",
"account_id": "ACC-001"
}
UTC timestamp when this tool was created, in ISO 8601 format. Use for auditing or determining how long the tool has been active.
"2024-04-20T10:00:00.000Z"
UTC timestamp when this tool was last modified, in ISO 8601 format. Use to detect configuration changes or invalidate cached tool definitions.
"2024-04-21T08:30:00.000Z"