Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
curl --request POST \
--url http://localhost:3000/v2/admin/connections/definitions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"slug": "<string>",
"name": "<string>",
"app": {
"slug": "<string>",
"name": "<string>",
"description": "<string>",
"developer_name": "<string>",
"icon_url": "<string>",
"category": "<string>",
"domain": "<string>",
"sort_order": 123
},
"adapter": {
"auth": {},
"key": "<string>",
"app": "<string>",
"member_sync": [
{
"task_id": "<string>",
"on": [
"<string>"
],
"identity": {}
}
]
},
"supported_account_scopes": [],
"description": "<string>",
"developer_name": "<string>",
"icon_url": "<string>",
"category": "<string>",
"sort_order": 123,
"mcp_catalog": {},
"tool_policy": {},
"allowed_tools": [
"<string>"
],
"allowed_actions": [
"<string>"
],
"allowed_triggers": [
"<string>"
],
"risk_summary": {},
"settings_schema": {}
}
'import requests
url = "http://localhost:3000/v2/admin/connections/definitions"
payload = {
"slug": "<string>",
"name": "<string>",
"app": {
"slug": "<string>",
"name": "<string>",
"description": "<string>",
"developer_name": "<string>",
"icon_url": "<string>",
"category": "<string>",
"domain": "<string>",
"sort_order": 123
},
"adapter": {
"auth": {},
"key": "<string>",
"app": "<string>",
"member_sync": [
{
"task_id": "<string>",
"on": ["<string>"],
"identity": {}
}
]
},
"supported_account_scopes": [],
"description": "<string>",
"developer_name": "<string>",
"icon_url": "<string>",
"category": "<string>",
"sort_order": 123,
"mcp_catalog": {},
"tool_policy": {},
"allowed_tools": ["<string>"],
"allowed_actions": ["<string>"],
"allowed_triggers": ["<string>"],
"risk_summary": {},
"settings_schema": {}
}
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({
slug: '<string>',
name: '<string>',
app: {
slug: '<string>',
name: '<string>',
description: '<string>',
developer_name: '<string>',
icon_url: '<string>',
category: '<string>',
domain: '<string>',
sort_order: 123
},
adapter: {
auth: {},
key: '<string>',
app: '<string>',
member_sync: [{task_id: '<string>', on: ['<string>'], identity: {}}]
},
supported_account_scopes: [],
description: '<string>',
developer_name: '<string>',
icon_url: '<string>',
category: '<string>',
sort_order: 123,
mcp_catalog: {},
tool_policy: {},
allowed_tools: ['<string>'],
allowed_actions: ['<string>'],
allowed_triggers: ['<string>'],
risk_summary: {},
settings_schema: {}
})
};
fetch('http://localhost:3000/v2/admin/connections/definitions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/v2/admin/connections/definitions",
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([
'slug' => '<string>',
'name' => '<string>',
'app' => [
'slug' => '<string>',
'name' => '<string>',
'description' => '<string>',
'developer_name' => '<string>',
'icon_url' => '<string>',
'category' => '<string>',
'domain' => '<string>',
'sort_order' => 123
],
'adapter' => [
'auth' => [
],
'key' => '<string>',
'app' => '<string>',
'member_sync' => [
[
'task_id' => '<string>',
'on' => [
'<string>'
],
'identity' => [
]
]
]
],
'supported_account_scopes' => [
],
'description' => '<string>',
'developer_name' => '<string>',
'icon_url' => '<string>',
'category' => '<string>',
'sort_order' => 123,
'mcp_catalog' => [
],
'tool_policy' => [
],
'allowed_tools' => [
'<string>'
],
'allowed_actions' => [
'<string>'
],
'allowed_triggers' => [
'<string>'
],
'risk_summary' => [
],
'settings_schema' => [
]
]),
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 := "http://localhost:3000/v2/admin/connections/definitions"
payload := strings.NewReader("{\n \"slug\": \"<string>\",\n \"name\": \"<string>\",\n \"app\": {\n \"slug\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"developer_name\": \"<string>\",\n \"icon_url\": \"<string>\",\n \"category\": \"<string>\",\n \"domain\": \"<string>\",\n \"sort_order\": 123\n },\n \"adapter\": {\n \"auth\": {},\n \"key\": \"<string>\",\n \"app\": \"<string>\",\n \"member_sync\": [\n {\n \"task_id\": \"<string>\",\n \"on\": [\n \"<string>\"\n ],\n \"identity\": {}\n }\n ]\n },\n \"supported_account_scopes\": [],\n \"description\": \"<string>\",\n \"developer_name\": \"<string>\",\n \"icon_url\": \"<string>\",\n \"category\": \"<string>\",\n \"sort_order\": 123,\n \"mcp_catalog\": {},\n \"tool_policy\": {},\n \"allowed_tools\": [\n \"<string>\"\n ],\n \"allowed_actions\": [\n \"<string>\"\n ],\n \"allowed_triggers\": [\n \"<string>\"\n ],\n \"risk_summary\": {},\n \"settings_schema\": {}\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("http://localhost:3000/v2/admin/connections/definitions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"slug\": \"<string>\",\n \"name\": \"<string>\",\n \"app\": {\n \"slug\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"developer_name\": \"<string>\",\n \"icon_url\": \"<string>\",\n \"category\": \"<string>\",\n \"domain\": \"<string>\",\n \"sort_order\": 123\n },\n \"adapter\": {\n \"auth\": {},\n \"key\": \"<string>\",\n \"app\": \"<string>\",\n \"member_sync\": [\n {\n \"task_id\": \"<string>\",\n \"on\": [\n \"<string>\"\n ],\n \"identity\": {}\n }\n ]\n },\n \"supported_account_scopes\": [],\n \"description\": \"<string>\",\n \"developer_name\": \"<string>\",\n \"icon_url\": \"<string>\",\n \"category\": \"<string>\",\n \"sort_order\": 123,\n \"mcp_catalog\": {},\n \"tool_policy\": {},\n \"allowed_tools\": [\n \"<string>\"\n ],\n \"allowed_actions\": [\n \"<string>\"\n ],\n \"allowed_triggers\": [\n \"<string>\"\n ],\n \"risk_summary\": {},\n \"settings_schema\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/v2/admin/connections/definitions")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"slug\": \"<string>\",\n \"name\": \"<string>\",\n \"app\": {\n \"slug\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"developer_name\": \"<string>\",\n \"icon_url\": \"<string>\",\n \"category\": \"<string>\",\n \"domain\": \"<string>\",\n \"sort_order\": 123\n },\n \"adapter\": {\n \"auth\": {},\n \"key\": \"<string>\",\n \"app\": \"<string>\",\n \"member_sync\": [\n {\n \"task_id\": \"<string>\",\n \"on\": [\n \"<string>\"\n ],\n \"identity\": {}\n }\n ]\n },\n \"supported_account_scopes\": [],\n \"description\": \"<string>\",\n \"developer_name\": \"<string>\",\n \"icon_url\": \"<string>\",\n \"category\": \"<string>\",\n \"sort_order\": 123,\n \"mcp_catalog\": {},\n \"tool_policy\": {},\n \"allowed_tools\": [\n \"<string>\"\n ],\n \"allowed_actions\": [\n \"<string>\"\n ],\n \"allowed_triggers\": [\n \"<string>\"\n ],\n \"risk_summary\": {},\n \"settings_schema\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"slug": "<string>",
"name": "<string>",
"description": "<string>",
"developer_name": "<string>",
"icon_url": "<string>",
"method": "<string>",
"status": "<string>",
"visibility": "<string>",
"supported_account_scopes": [
"<string>"
],
"category": "<string>",
"installed": true,
"connection_type": "app",
"origin": "base39",
"installation_method": "<string>",
"connect_strategy": "connect_link",
"reconciles_on_connect": true,
"loads_external_identities": true,
"static_credential_params": [
{
"in": "header",
"key": "<string>",
"label": "<string>",
"secret": true
}
],
"mcp_catalog": {
"server_instructions": "<string>",
"tools": [
{
"name": "<string>",
"title": "<string>",
"description": "<string>",
"input_schema": {},
"output_schema": {},
"annotations": {},
"risk": "read"
}
],
"prompts": [
{
"name": "<string>",
"title": "<string>",
"description": "<string>",
"arguments": [
{}
]
}
],
"resources": [
{
"uri": "<string>",
"name": "<string>",
"title": "<string>",
"description": "<string>",
"mime_type": "<string>"
}
],
"resource_templates": [
{
"uri_template": "<string>",
"name": "<string>",
"title": "<string>",
"description": "<string>",
"mime_type": "<string>"
}
]
},
"settings_schema": {}
}curl --request POST \
--url http://localhost:3000/v2/admin/connections/definitions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"slug": "<string>",
"name": "<string>",
"app": {
"slug": "<string>",
"name": "<string>",
"description": "<string>",
"developer_name": "<string>",
"icon_url": "<string>",
"category": "<string>",
"domain": "<string>",
"sort_order": 123
},
"adapter": {
"auth": {},
"key": "<string>",
"app": "<string>",
"member_sync": [
{
"task_id": "<string>",
"on": [
"<string>"
],
"identity": {}
}
]
},
"supported_account_scopes": [],
"description": "<string>",
"developer_name": "<string>",
"icon_url": "<string>",
"category": "<string>",
"sort_order": 123,
"mcp_catalog": {},
"tool_policy": {},
"allowed_tools": [
"<string>"
],
"allowed_actions": [
"<string>"
],
"allowed_triggers": [
"<string>"
],
"risk_summary": {},
"settings_schema": {}
}
'import requests
url = "http://localhost:3000/v2/admin/connections/definitions"
payload = {
"slug": "<string>",
"name": "<string>",
"app": {
"slug": "<string>",
"name": "<string>",
"description": "<string>",
"developer_name": "<string>",
"icon_url": "<string>",
"category": "<string>",
"domain": "<string>",
"sort_order": 123
},
"adapter": {
"auth": {},
"key": "<string>",
"app": "<string>",
"member_sync": [
{
"task_id": "<string>",
"on": ["<string>"],
"identity": {}
}
]
},
"supported_account_scopes": [],
"description": "<string>",
"developer_name": "<string>",
"icon_url": "<string>",
"category": "<string>",
"sort_order": 123,
"mcp_catalog": {},
"tool_policy": {},
"allowed_tools": ["<string>"],
"allowed_actions": ["<string>"],
"allowed_triggers": ["<string>"],
"risk_summary": {},
"settings_schema": {}
}
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({
slug: '<string>',
name: '<string>',
app: {
slug: '<string>',
name: '<string>',
description: '<string>',
developer_name: '<string>',
icon_url: '<string>',
category: '<string>',
domain: '<string>',
sort_order: 123
},
adapter: {
auth: {},
key: '<string>',
app: '<string>',
member_sync: [{task_id: '<string>', on: ['<string>'], identity: {}}]
},
supported_account_scopes: [],
description: '<string>',
developer_name: '<string>',
icon_url: '<string>',
category: '<string>',
sort_order: 123,
mcp_catalog: {},
tool_policy: {},
allowed_tools: ['<string>'],
allowed_actions: ['<string>'],
allowed_triggers: ['<string>'],
risk_summary: {},
settings_schema: {}
})
};
fetch('http://localhost:3000/v2/admin/connections/definitions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/v2/admin/connections/definitions",
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([
'slug' => '<string>',
'name' => '<string>',
'app' => [
'slug' => '<string>',
'name' => '<string>',
'description' => '<string>',
'developer_name' => '<string>',
'icon_url' => '<string>',
'category' => '<string>',
'domain' => '<string>',
'sort_order' => 123
],
'adapter' => [
'auth' => [
],
'key' => '<string>',
'app' => '<string>',
'member_sync' => [
[
'task_id' => '<string>',
'on' => [
'<string>'
],
'identity' => [
]
]
]
],
'supported_account_scopes' => [
],
'description' => '<string>',
'developer_name' => '<string>',
'icon_url' => '<string>',
'category' => '<string>',
'sort_order' => 123,
'mcp_catalog' => [
],
'tool_policy' => [
],
'allowed_tools' => [
'<string>'
],
'allowed_actions' => [
'<string>'
],
'allowed_triggers' => [
'<string>'
],
'risk_summary' => [
],
'settings_schema' => [
]
]),
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 := "http://localhost:3000/v2/admin/connections/definitions"
payload := strings.NewReader("{\n \"slug\": \"<string>\",\n \"name\": \"<string>\",\n \"app\": {\n \"slug\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"developer_name\": \"<string>\",\n \"icon_url\": \"<string>\",\n \"category\": \"<string>\",\n \"domain\": \"<string>\",\n \"sort_order\": 123\n },\n \"adapter\": {\n \"auth\": {},\n \"key\": \"<string>\",\n \"app\": \"<string>\",\n \"member_sync\": [\n {\n \"task_id\": \"<string>\",\n \"on\": [\n \"<string>\"\n ],\n \"identity\": {}\n }\n ]\n },\n \"supported_account_scopes\": [],\n \"description\": \"<string>\",\n \"developer_name\": \"<string>\",\n \"icon_url\": \"<string>\",\n \"category\": \"<string>\",\n \"sort_order\": 123,\n \"mcp_catalog\": {},\n \"tool_policy\": {},\n \"allowed_tools\": [\n \"<string>\"\n ],\n \"allowed_actions\": [\n \"<string>\"\n ],\n \"allowed_triggers\": [\n \"<string>\"\n ],\n \"risk_summary\": {},\n \"settings_schema\": {}\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("http://localhost:3000/v2/admin/connections/definitions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"slug\": \"<string>\",\n \"name\": \"<string>\",\n \"app\": {\n \"slug\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"developer_name\": \"<string>\",\n \"icon_url\": \"<string>\",\n \"category\": \"<string>\",\n \"domain\": \"<string>\",\n \"sort_order\": 123\n },\n \"adapter\": {\n \"auth\": {},\n \"key\": \"<string>\",\n \"app\": \"<string>\",\n \"member_sync\": [\n {\n \"task_id\": \"<string>\",\n \"on\": [\n \"<string>\"\n ],\n \"identity\": {}\n }\n ]\n },\n \"supported_account_scopes\": [],\n \"description\": \"<string>\",\n \"developer_name\": \"<string>\",\n \"icon_url\": \"<string>\",\n \"category\": \"<string>\",\n \"sort_order\": 123,\n \"mcp_catalog\": {},\n \"tool_policy\": {},\n \"allowed_tools\": [\n \"<string>\"\n ],\n \"allowed_actions\": [\n \"<string>\"\n ],\n \"allowed_triggers\": [\n \"<string>\"\n ],\n \"risk_summary\": {},\n \"settings_schema\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/v2/admin/connections/definitions")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"slug\": \"<string>\",\n \"name\": \"<string>\",\n \"app\": {\n \"slug\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"developer_name\": \"<string>\",\n \"icon_url\": \"<string>\",\n \"category\": \"<string>\",\n \"domain\": \"<string>\",\n \"sort_order\": 123\n },\n \"adapter\": {\n \"auth\": {},\n \"key\": \"<string>\",\n \"app\": \"<string>\",\n \"member_sync\": [\n {\n \"task_id\": \"<string>\",\n \"on\": [\n \"<string>\"\n ],\n \"identity\": {}\n }\n ]\n },\n \"supported_account_scopes\": [],\n \"description\": \"<string>\",\n \"developer_name\": \"<string>\",\n \"icon_url\": \"<string>\",\n \"category\": \"<string>\",\n \"sort_order\": 123,\n \"mcp_catalog\": {},\n \"tool_policy\": {},\n \"allowed_tools\": [\n \"<string>\"\n ],\n \"allowed_actions\": [\n \"<string>\"\n ],\n \"allowed_triggers\": [\n \"<string>\"\n ],\n \"risk_summary\": {},\n \"settings_schema\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"slug": "<string>",
"name": "<string>",
"description": "<string>",
"developer_name": "<string>",
"icon_url": "<string>",
"method": "<string>",
"status": "<string>",
"visibility": "<string>",
"supported_account_scopes": [
"<string>"
],
"category": "<string>",
"installed": true,
"connection_type": "app",
"origin": "base39",
"installation_method": "<string>",
"connect_strategy": "connect_link",
"reconciles_on_connect": true,
"loads_external_identities": true,
"static_credential_params": [
{
"in": "header",
"key": "<string>",
"label": "<string>",
"secret": true
}
],
"mcp_catalog": {
"server_instructions": "<string>",
"tools": [
{
"name": "<string>",
"title": "<string>",
"description": "<string>",
"input_schema": {},
"output_schema": {},
"annotations": {},
"risk": "read"
}
],
"prompts": [
{
"name": "<string>",
"title": "<string>",
"description": "<string>",
"arguments": [
{}
]
}
],
"resources": [
{
"uri": "<string>",
"name": "<string>",
"title": "<string>",
"description": "<string>",
"mime_type": "<string>"
}
],
"resource_templates": [
{
"uri_template": "<string>",
"name": "<string>",
"title": "<string>",
"description": "<string>",
"mime_type": "<string>"
}
]
},
"settings_schema": {}
}OAuth2 Authorization Code flow
Show child attributes
Show child attributes
cross-org, org, user app, mcp, ai, api, webhook, channel base39, partner, custom oauth, static, task_id public, private, internal draft, active, disabled, archived app, mcp, ai, api, webhook, channel base39, partner, custom connect_link, install Show child attributes
Show child attributes