Skip to main content
GET
/
v1
/
integrations
/
{integrationId}
/
tools
/
{toolId}
Get Tool
curl --request GET \
  --url https://api.sigmamind.ai/v1/integrations/{integrationId}/tools/{toolId} \
  --header 'X-API-Key: <api-key>'
{
  "toolId": "tool-X9pLm2Wq8Rt3",
  "integrationId": "intg-AuUKK371Spr5",
  "name": "Get Order Details",
  "description": "Fetches order details from Shopify by order ID",
  "method": "GET",
  "url": "/orders/{orderId}.json",
  "scope": "local",
  "headers": {
    "customer_name": "Michael"
  },
  "queryParams": {
    "customer_name": "Michael"
  },
  "bodyParams": {
    "customer_name": "Michael"
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

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.

Authorizations

​
X-API-Key
string
header
required

API Key is required in header. You can find it in the settings

Path Parameters

​
integrationId
string
required

Unique identifier for the integration

​
toolId
string
required

Unique identifier for the tool

Response

OK

​
toolId
string

Unique identifier for the tool

Example:

"tool-X9pLm2Wq8Rt3"

​
integrationId
string

Unique identifier of the parent integration

Example:

"intg-AuUKK371Spr5"

​
name
string

Human-readable name for this tool

Example:

"Get Order Details"

​
description
string

Description of what this tool does

Example:

"Fetches order details from Shopify by order ID"

​
method
string

HTTP method

Example:

"GET"

​
url
string

Relative path of the API endpoint

Example:

"/orders/{orderId}.json"

​
scope
enum<string>

Scope of the tool

Available options:
local,
community
Example:

"local"

​
headers
object

A set of dynamic key-value pairs required by the selected Agent. These variables allow personalization of the call, such as passing the customer’s name or other contextual details.

Example:
{ "customer_name": "Michael" }
​
queryParams
object

A set of dynamic key-value pairs required by the selected Agent. These variables allow personalization of the call, such as passing the customer’s name or other contextual details.

Example:
{ "customer_name": "Michael" }
​
bodyParams
object

A set of dynamic key-value pairs required by the selected Agent. These variables allow personalization of the call, such as passing the customer’s name or other contextual details.

Example:
{ "customer_name": "Michael" }
​
createdAt
string<date-time>

Timestamp when the record was created

​
updatedAt
string<date-time>

Timestamp when the record was last updated