Create Integration Auth
curl --request POST \
--url https://api.sigmamind.ai/v1/integrations/{integrationId}/auth \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"authType": "API_KEY",
"token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
"username": "api_user@example.com",
"password": "s3cretP@ssword",
"apiKey": {
"key": "X-API-KEY",
"value": "<secret>",
"position": "header"
},
"headers": [
{
"key": "X-Request-Source",
"value": "sigmamind"
}
]
}
'import requests
url = "https://api.sigmamind.ai/v1/integrations/{integrationId}/auth"
payload = {
"authType": "API_KEY",
"token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
"username": "api_user@example.com",
"password": "s3cretP@ssword",
"apiKey": {
"key": "X-API-KEY",
"value": "<secret>",
"position": "header"
},
"headers": [
{
"key": "X-Request-Source",
"value": "sigmamind"
}
]
}
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({
authType: 'API_KEY',
token: 'eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...',
username: 'api_user@example.com',
password: 's3cretP@ssword',
apiKey: {key: 'X-API-KEY', value: '<secret>', position: 'header'},
headers: [{key: 'X-Request-Source', value: 'sigmamind'}]
})
};
fetch('https://api.sigmamind.ai/v1/integrations/{integrationId}/auth', 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}/auth",
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([
'authType' => 'API_KEY',
'token' => 'eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...',
'username' => 'api_user@example.com',
'password' => 's3cretP@ssword',
'apiKey' => [
'key' => 'X-API-KEY',
'value' => '<secret>',
'position' => 'header'
],
'headers' => [
[
'key' => 'X-Request-Source',
'value' => 'sigmamind'
]
]
]),
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}/auth"
payload := strings.NewReader("{\n \"authType\": \"API_KEY\",\n \"token\": \"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...\",\n \"username\": \"api_user@example.com\",\n \"password\": \"s3cretP@ssword\",\n \"apiKey\": {\n \"key\": \"X-API-KEY\",\n \"value\": \"<secret>\",\n \"position\": \"header\"\n },\n \"headers\": [\n {\n \"key\": \"X-Request-Source\",\n \"value\": \"sigmamind\"\n }\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}/auth")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"authType\": \"API_KEY\",\n \"token\": \"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...\",\n \"username\": \"api_user@example.com\",\n \"password\": \"s3cretP@ssword\",\n \"apiKey\": {\n \"key\": \"X-API-KEY\",\n \"value\": \"<secret>\",\n \"position\": \"header\"\n },\n \"headers\": [\n {\n \"key\": \"X-Request-Source\",\n \"value\": \"sigmamind\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sigmamind.ai/v1/integrations/{integrationId}/auth")
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 \"authType\": \"API_KEY\",\n \"token\": \"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...\",\n \"username\": \"api_user@example.com\",\n \"password\": \"s3cretP@ssword\",\n \"apiKey\": {\n \"key\": \"X-API-KEY\",\n \"value\": \"<secret>\",\n \"position\": \"header\"\n },\n \"headers\": [\n {\n \"key\": \"X-Request-Source\",\n \"value\": \"sigmamind\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"authId": "auth_P3kNz7Yv1Qm9",
"integrationId": "intg_AuUKK371Spr5",
"authType": "API_KEY",
"headers": [
{
"key": "X-Request-Source",
"value": "sigmamind"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}{
"error": "Bad Request",
"message": "Invalid request parameters",
"path": "/v1/integrations/{integrationId}/auth",
"status": 400,
"timestamp": "2026-05-05T10:06:45.814Z"
}{
"error": "Unauthorized",
"message": "X-API-Key is missing or invalid",
"path": "/v1/integrations/{integrationId}/auth",
"status": 401,
"timestamp": "2026-05-05T10:06:45.814Z"
}{
"error": "Forbidden",
"message": "Access denied for this resource",
"path": "/v1/integrations/{integrationId}/auth",
"status": 403,
"timestamp": "2026-05-05T10:06:45.814Z"
}{
"error": "Not Found",
"message": "The requested resource was not found",
"path": "/v1/integrations/{integrationId}/auth",
"status": 404,
"timestamp": "2026-05-05T10:06:45.814Z"
}{
"error": "Internal Server Error",
"message": "Unexpected server error",
"path": "/v1/integrations/{integrationId}/auth",
"status": 500,
"timestamp": "2026-05-05T10:06:45.814Z"
}Integration Auth
Create Integration Auth
Creates and stores authentication credentials for an integration. Supports three auth types: API Key, Basic auth, and Bearer token. Returns the created auth record including its authId, which is required for subsequent get, update, and delete calls.
POST
/
v1
/
integrations
/
{integrationId}
/
auth
Create Integration Auth
curl --request POST \
--url https://api.sigmamind.ai/v1/integrations/{integrationId}/auth \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"authType": "API_KEY",
"token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
"username": "api_user@example.com",
"password": "s3cretP@ssword",
"apiKey": {
"key": "X-API-KEY",
"value": "<secret>",
"position": "header"
},
"headers": [
{
"key": "X-Request-Source",
"value": "sigmamind"
}
]
}
'import requests
url = "https://api.sigmamind.ai/v1/integrations/{integrationId}/auth"
payload = {
"authType": "API_KEY",
"token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
"username": "api_user@example.com",
"password": "s3cretP@ssword",
"apiKey": {
"key": "X-API-KEY",
"value": "<secret>",
"position": "header"
},
"headers": [
{
"key": "X-Request-Source",
"value": "sigmamind"
}
]
}
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({
authType: 'API_KEY',
token: 'eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...',
username: 'api_user@example.com',
password: 's3cretP@ssword',
apiKey: {key: 'X-API-KEY', value: '<secret>', position: 'header'},
headers: [{key: 'X-Request-Source', value: 'sigmamind'}]
})
};
fetch('https://api.sigmamind.ai/v1/integrations/{integrationId}/auth', 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}/auth",
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([
'authType' => 'API_KEY',
'token' => 'eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...',
'username' => 'api_user@example.com',
'password' => 's3cretP@ssword',
'apiKey' => [
'key' => 'X-API-KEY',
'value' => '<secret>',
'position' => 'header'
],
'headers' => [
[
'key' => 'X-Request-Source',
'value' => 'sigmamind'
]
]
]),
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}/auth"
payload := strings.NewReader("{\n \"authType\": \"API_KEY\",\n \"token\": \"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...\",\n \"username\": \"api_user@example.com\",\n \"password\": \"s3cretP@ssword\",\n \"apiKey\": {\n \"key\": \"X-API-KEY\",\n \"value\": \"<secret>\",\n \"position\": \"header\"\n },\n \"headers\": [\n {\n \"key\": \"X-Request-Source\",\n \"value\": \"sigmamind\"\n }\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}/auth")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"authType\": \"API_KEY\",\n \"token\": \"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...\",\n \"username\": \"api_user@example.com\",\n \"password\": \"s3cretP@ssword\",\n \"apiKey\": {\n \"key\": \"X-API-KEY\",\n \"value\": \"<secret>\",\n \"position\": \"header\"\n },\n \"headers\": [\n {\n \"key\": \"X-Request-Source\",\n \"value\": \"sigmamind\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sigmamind.ai/v1/integrations/{integrationId}/auth")
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 \"authType\": \"API_KEY\",\n \"token\": \"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...\",\n \"username\": \"api_user@example.com\",\n \"password\": \"s3cretP@ssword\",\n \"apiKey\": {\n \"key\": \"X-API-KEY\",\n \"value\": \"<secret>\",\n \"position\": \"header\"\n },\n \"headers\": [\n {\n \"key\": \"X-Request-Source\",\n \"value\": \"sigmamind\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"authId": "auth_P3kNz7Yv1Qm9",
"integrationId": "intg_AuUKK371Spr5",
"authType": "API_KEY",
"headers": [
{
"key": "X-Request-Source",
"value": "sigmamind"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}{
"error": "Bad Request",
"message": "Invalid request parameters",
"path": "/v1/integrations/{integrationId}/auth",
"status": 400,
"timestamp": "2026-05-05T10:06:45.814Z"
}{
"error": "Unauthorized",
"message": "X-API-Key is missing or invalid",
"path": "/v1/integrations/{integrationId}/auth",
"status": 401,
"timestamp": "2026-05-05T10:06:45.814Z"
}{
"error": "Forbidden",
"message": "Access denied for this resource",
"path": "/v1/integrations/{integrationId}/auth",
"status": 403,
"timestamp": "2026-05-05T10:06:45.814Z"
}{
"error": "Not Found",
"message": "The requested resource was not found",
"path": "/v1/integrations/{integrationId}/auth",
"status": 404,
"timestamp": "2026-05-05T10:06:45.814Z"
}{
"error": "Internal Server Error",
"message": "Unexpected server error",
"path": "/v1/integrations/{integrationId}/auth",
"status": 500,
"timestamp": "2026-05-05T10:06:45.814Z"
}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 for the integration
Body
application/json
Defines authentication credentials for a third-party integration. Use this to tell the system how to authenticate outbound API requests. Select an authType and provide only the fields required for that type. All other fields will be ignored. This configuration is applied automatically to every request made using this integration.
Specifies the authentication method used for outgoing requests. Choose based on how the target API expects credentials: API_KEY → when a key must be sent via header or query parameter. BEARER_TOKEN → when a token is sent in the Authorization header. BASIC_AUTH → when username/password is required. NO_AUTH → when no authentication is needed. This field determines which other fields must be provided.
Available options:
NO_AUTH, BASIC_AUTH, BEARER_TOKEN, API_KEY Example:
"API_KEY"
Access token used for Bearer authentication. Required only when authType is BEARER_TOKEN. Automatically added to requests as: Authorization: Bearer .
Example:
"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..."
Username used for Basic authentication. Required only when authType is BASIC_AUTH. Combined with password and encoded into the Authorization header.
Maximum string length:
256Example:
"api_user@example.com"
Password used for Basic authentication. Required only when authType is BASIC_AUTH. Combined with username and encoded into the Authorization header.
Example:
"s3cretP@ssword"
Defines how an API key is attached to outgoing requests. Use this when the API requires a key in headers or query parameters.
Show child attributes
Show child attributes
Example:
{
"key": "X-API-KEY",
"value": "<secret>",
"position": "header"
}
Optional static headers that will be included in every outgoing request. Useful for fixed metadata or required headers that do not change per request. These are applied in addition to authentication headers.
Show child attributes
Show child attributes
Example:
[
{
"key": "X-Request-Source",
"value": "sigmamind"
}
]
Response
Created
Unique identifier for the auth record
Example:
"auth_P3kNz7Yv1Qm9"
Unique identifier of the parent integration
Example:
"intg_AuUKK371Spr5"
The authentication strategy this credential set uses. Determines which credential fields are required: API_KEY — provide the apiKey object (key name, secret value, and position). BEARER_TOKEN — provide the token field. BASIC_AUTH — provide username and password fields. NO_AUTH — no credential fields required.
Available options:
NO_AUTH, BASIC_AUTH, BEARER_TOKEN, API_KEY Example:
"API_KEY"
Optional list of static HTTP headers attached to every outbound request under this auth. Applied on top of any headers defined at the integration or tool level. Useful for fixed metadata headers required by the third-party API.
Example:
[
{
"key": "X-Request-Source",
"value": "sigmamind"
}
]
Timestamp when the record was created
Timestamp when the record was last updated