Create Connection

Create a new connection with validation.

This endpoint validates the provided credentials and configuration against the integration’s requirements before creating the connection.

Validation includes:

• Required fields are present
• Field types match expected types (email, url, etc.)
• Values match validation patterns (regex)
• Length constraints are met
• OAuth credentials are valid (if applicable)

Example:

{
    "label": "My Gmail Connection",
    "integration": "gmail",
    "integration_type": "connectors",
    "auth_method_id": "oauth2",
    "credentials": {
        "access_token": "ya29.a0...",
        "refresh_token": "1//0g...",
        "token_type": "Bearer",
        "expires_at": "2025-10-19T12:00:00Z"
    },
    "config": {}
}

Error Response (validation failure):

{
    "detail": {
        "message": "Connection validation failed",
        "errors": [
            "Field 'API Key' is required",
            "Field 'Email' must be a valid email address"
        ]
    }
}

POST /api/v1/connections

Create Connection

cURL

curl --request POST \
  --url https://api.example.com/api/v1/connections \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "integration": "<string>",
  "label": "<string>",
  "config": {},
  "credential_id": "<string>",
  "user_id": "<string>",
  "credentials": {},
  "auth_method_id": "<string>"
}
'

import requests

url = "https://api.example.com/api/v1/connections"

payload = {
    "integration": "<string>",
    "label": "<string>",
    "config": {},
    "credential_id": "<string>",
    "user_id": "<string>",
    "credentials": {},
    "auth_method_id": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    integration: '<string>',
    label: '<string>',
    config: {},
    credential_id: '<string>',
    user_id: '<string>',
    credentials: {},
    auth_method_id: '<string>'
  })
};

fetch('https://api.example.com/api/v1/connections', 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.example.com/api/v1/connections",
  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([
    'integration' => '<string>',
    'label' => '<string>',
    'config' => [
        
    ],
    'credential_id' => '<string>',
    'user_id' => '<string>',
    'credentials' => [
        
    ],
    'auth_method_id' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.example.com/api/v1/connections"

	payload := strings.NewReader("{\n  \"integration\": \"<string>\",\n  \"label\": \"<string>\",\n  \"config\": {},\n  \"credential_id\": \"<string>\",\n  \"user_id\": \"<string>\",\n  \"credentials\": {},\n  \"auth_method_id\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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.example.com/api/v1/connections")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"integration\": \"<string>\",\n  \"label\": \"<string>\",\n  \"config\": {},\n  \"credential_id\": \"<string>\",\n  \"user_id\": \"<string>\",\n  \"credentials\": {},\n  \"auth_method_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/connections")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"integration\": \"<string>\",\n  \"label\": \"<string>\",\n  \"config\": {},\n  \"credential_id\": \"<string>\",\n  \"user_id\": \"<string>\",\n  \"credentials\": {},\n  \"auth_method_id\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "integration": "<string>",
  "id": "<string>",
  "credential_id": "<string>",
  "user_id": "<string>",
  "workspace_id": "<string>",
  "created_by": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "label": "<string>",
  "config": {}
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Workspace-Id · string | null

The workspace ID

Body

application/json

Schema for creating a new connection.

integration · string · required

Integration name (slack, github, etc.)

integration_type · enum<string> · required

Type of integration (connectors, mcp, tool, model, storage, api, custom)

Available options: connectors, mcp, tool, model, custom, storage, api

label · string | null

Human-readable label for the connection

Maximum string length: 255

config · Config · object

Integration-specific configuration

credential_id · string | null

ID of the credential to use for this connection

user_id · string | null

User ID who owns this connection

credentials · Credentials · object | null

Credentials to use for this connection

auth_method_id · string | null

Authentication method ID to use (defaults to integration's default method)

Response

200

application/json

Successful Response

Schema for reading connection data.

integration · string · required

Integration name (slack, github, etc.)

integration_type · enum<string> · required

Type of integration (connectors, mcp, tool, model, storage, api, custom)

Available options: connectors, mcp, tool, model, custom, storage, api

id · string · required

credential_id · string · required

user_id · string | null · required

workspace_id · string · required

created_by · string · required

status · enum<string> · required

Available options: active, inactive, testing, error, expired

created_at · string<date-time> · required

updated_at · string<date-time> · required

label · string | null

Human-readable label for the connection

Maximum string length: 255

config · Config · object

Integration-specific configuration