Skip to main content
POST
/
v1
/
integrations
Create Integration
curl --request POST \
  --url https://api.sigmamind.ai/v1/integrations \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "my_shopify_store",
  "description": "Handles order lookups for the support agent"
}
'
{
  "integrationId": "intg-AuUKK371Spr5",
  "name": "My Shopify Store",
  "description": "Handles order lookups for the support agent",
  "authentication": {
    "authId": "auth-P3kNz7Yv1Qm9",
    "integrationId": "intg-AuUKK371Spr5",
    "authType": "api_key",
    "headers": {},
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "tools": [
    {
      "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"
    }
  ],
  "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

Body

application/json
​
name
string
required

Human-readable label for this integration

Maximum string length: 128
Pattern: ^[a-z]+(_[a-z]+)*$
Example:

"my_shopify_store"

​
description
string

Optional description of what this integration is used for

Maximum string length: 512
Example:

"Handles order lookups for the support agent"

Response

OK

​
integrationId
string

Unique identifier for the integration

Example:

"intg-AuUKK371Spr5"

​
name
string

Human-readable label for this integration

Example:

"My Shopify Store"

​
description
string

Optional description of what this integration is used for

Example:

"Handles order lookups for the support agent"

​
authentication
object
​
tools
object[]
​
createdAt
string<date-time>

Timestamp when the record was created

​
updatedAt
string<date-time>

Timestamp when the record was last updated