Create Connection

POST

workspaces

{workspace}

openapi-connections

Create Connection

curl --request POST \
  --url https://api.example.com/v1/workspaces/{workspace}/openapi-connections/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "base_url": "<string>",
  "name": "<string>",
  "auth_config_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "custom_headers": [
    {
      "name": "<string>",
      "value": ""
    }
  ],
  "custom_query_params": [
    {
      "name": "<string>",
      "secret": true,
      "value": ""
    }
  ],
  "description": "<string>",
  "spec_content": {},
  "spec_url": "<string>",
  "url_variables": [
    {
      "name": "<string>",
      "value": "<string>"
    }
  ]
}
'

import requests

url = "https://api.example.com/v1/workspaces/{workspace}/openapi-connections/"

payload = {
    "base_url": "<string>",
    "name": "<string>",
    "auth_config_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "custom_headers": [
        {
            "name": "<string>",
            "value": ""
        }
    ],
    "custom_query_params": [
        {
            "name": "<string>",
            "secret": True,
            "value": ""
        }
    ],
    "description": "<string>",
    "spec_content": {},
    "spec_url": "<string>",
    "url_variables": [
        {
            "name": "<string>",
            "value": "<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({
    base_url: '<string>',
    name: '<string>',
    auth_config_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    custom_headers: [{name: '<string>', value: ''}],
    custom_query_params: [{name: '<string>', secret: true, value: ''}],
    description: '<string>',
    spec_content: {},
    spec_url: '<string>',
    url_variables: [{name: '<string>', value: '<string>'}]
  })
};

fetch('https://api.example.com/v1/workspaces/{workspace}/openapi-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/v1/workspaces/{workspace}/openapi-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([
    'base_url' => '<string>',
    'name' => '<string>',
    'auth_config_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'custom_headers' => [
        [
                'name' => '<string>',
                'value' => ''
        ]
    ],
    'custom_query_params' => [
        [
                'name' => '<string>',
                'secret' => true,
                'value' => ''
        ]
    ],
    'description' => '<string>',
    'spec_content' => [
        
    ],
    'spec_url' => '<string>',
    'url_variables' => [
        [
                'name' => '<string>',
                'value' => '<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/v1/workspaces/{workspace}/openapi-connections/"

	payload := strings.NewReader("{\n  \"base_url\": \"<string>\",\n  \"name\": \"<string>\",\n  \"auth_config_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"custom_headers\": [\n    {\n      \"name\": \"<string>\",\n      \"value\": \"\"\n    }\n  ],\n  \"custom_query_params\": [\n    {\n      \"name\": \"<string>\",\n      \"secret\": true,\n      \"value\": \"\"\n    }\n  ],\n  \"description\": \"<string>\",\n  \"spec_content\": {},\n  \"spec_url\": \"<string>\",\n  \"url_variables\": [\n    {\n      \"name\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ]\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/v1/workspaces/{workspace}/openapi-connections/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"base_url\": \"<string>\",\n  \"name\": \"<string>\",\n  \"auth_config_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"custom_headers\": [\n    {\n      \"name\": \"<string>\",\n      \"value\": \"\"\n    }\n  ],\n  \"custom_query_params\": [\n    {\n      \"name\": \"<string>\",\n      \"secret\": true,\n      \"value\": \"\"\n    }\n  ],\n  \"description\": \"<string>\",\n  \"spec_content\": {},\n  \"spec_url\": \"<string>\",\n  \"url_variables\": [\n    {\n      \"name\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/workspaces/{workspace}/openapi-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  \"base_url\": \"<string>\",\n  \"name\": \"<string>\",\n  \"auth_config_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"custom_headers\": [\n    {\n      \"name\": \"<string>\",\n      \"value\": \"\"\n    }\n  ],\n  \"custom_query_params\": [\n    {\n      \"name\": \"<string>\",\n      \"secret\": true,\n      \"value\": \"\"\n    }\n  ],\n  \"description\": \"<string>\",\n  \"spec_content\": {},\n  \"spec_url\": \"<string>\",\n  \"url_variables\": [\n    {\n      \"name\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ]\n}"

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

{
  "available_tools": [
    {
      "description": "<string>",
      "inputSchema": {},
      "name": "<string>"
    }
  ],
  "base_url": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "status": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "auth_config_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "cost": {},
  "custom_headers": [
    {
      "name": "<string>",
      "secret": true,
      "value": "<string>"
    }
  ],
  "custom_query_params": [
    {
      "name": "<string>",
      "secret": true,
      "value": "<string>"
    }
  ],
  "description": "<string>",
  "last_dispatch": {},
  "managed_by": "<string>",
  "registry_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "spec_url": "<string>",
  "url_variables": [
    "<string>"
  ]
}

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

Authorizations

Authorization

string

header

required

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

Path Parameters

workspace

string

required

Slug of the workspace the request acts in

Maximum string length: 120

Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$

Body

application/json

Payload for creating an OpenAPI connection.

The connection ties a base URL (where requests are sent) to an OpenAPI 3.x specification (which is parsed eagerly into a tool list). Provide either spec_url or spec_content — not both required.

base_url

string

required

Base URL for API requests, e.g. 'https://api.example.com'. The path may hold '{name}' placeholders filled from url_variables, e.g. 'https://api.telegram.org/bot{token}'.

Maximum string length: 500

name

string

required

Display name for the connection (unique per workspace).

Required string length: 1 - 255

auth_config_id

string<uuid> | null

Optional MCPAuthConfig UUID for OAuth2 token rotation. When set, tokens are minted/refreshed on the connection's behalf.

custom_headers

HeaderInput · object[] | null

Custom HTTP headers attached to every request. Non-safe headers (e.g. Authorization) are stored encrypted in the secret manager.

Show child attributes

custom_query_params

QueryParamInput · object[] | null

Query parameters attached to every request, e.g. an API key the upstream takes as '?api_key='. Secret values are stored encrypted in the secret manager.

Show child attributes

description

string | null

Optional human-readable summary of what this API exposes.

spec_content

Spec Content · object | null

Inline OpenAPI 3.x spec as a JSON object. Use instead of spec_url when the spec host is unreachable from the API.

spec_url

string | null

URL to an OpenAPI 3.x JSON or YAML spec. The spec is fetched and parsed eagerly at create time so the connection is ready for use.

url_variables

UrlVariableInput · object[] | null

Secret values for the '{name}' placeholders in the base URL path, one per placeholder. Stored encrypted in the secret manager.

Show child attributes

Response

Successful Response

available_tools

OpenAPIToolResponse · object[]

required

Show child attributes

base_url

string | null

required

created_at

string<date-time>

required

string<uuid>

required

name

string

required

status

string

required

updated_at

string<date-time>

required

auth_config_id

string<uuid> | null

cost

Cost · object | null

custom_headers

HeaderOutput · object[] | null

Show child attributes

custom_query_params

QueryParamOutput · object[] | null

Show child attributes

description

string | null

last_dispatch

Last Dispatch · object | null

managed_by

string | null

registry_item_id

string<uuid> | null

spec_url

string | null

url_variables

string[] | null

Create Connection

curl --request POST \
  --url https://api.example.com/v1/workspaces/{workspace}/openapi-connections/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "base_url": "<string>",
  "name": "<string>",
  "auth_config_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "custom_headers": [
    {
      "name": "<string>",
      "value": ""
    }
  ],
  "custom_query_params": [
    {
      "name": "<string>",
      "secret": true,
      "value": ""
    }
  ],
  "description": "<string>",
  "spec_content": {},
  "spec_url": "<string>",
  "url_variables": [
    {
      "name": "<string>",
      "value": "<string>"
    }
  ]
}
'

import requests

url = "https://api.example.com/v1/workspaces/{workspace}/openapi-connections/"

payload = {
    "base_url": "<string>",
    "name": "<string>",
    "auth_config_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "custom_headers": [
        {
            "name": "<string>",
            "value": ""
        }
    ],
    "custom_query_params": [
        {
            "name": "<string>",
            "secret": True,
            "value": ""
        }
    ],
    "description": "<string>",
    "spec_content": {},
    "spec_url": "<string>",
    "url_variables": [
        {
            "name": "<string>",
            "value": "<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({
    base_url: '<string>',
    name: '<string>',
    auth_config_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    custom_headers: [{name: '<string>', value: ''}],
    custom_query_params: [{name: '<string>', secret: true, value: ''}],
    description: '<string>',
    spec_content: {},
    spec_url: '<string>',
    url_variables: [{name: '<string>', value: '<string>'}]
  })
};

fetch('https://api.example.com/v1/workspaces/{workspace}/openapi-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/v1/workspaces/{workspace}/openapi-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([
    'base_url' => '<string>',
    'name' => '<string>',
    'auth_config_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'custom_headers' => [
        [
                'name' => '<string>',
                'value' => ''
        ]
    ],
    'custom_query_params' => [
        [
                'name' => '<string>',
                'secret' => true,
                'value' => ''
        ]
    ],
    'description' => '<string>',
    'spec_content' => [
        
    ],
    'spec_url' => '<string>',
    'url_variables' => [
        [
                'name' => '<string>',
                'value' => '<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/v1/workspaces/{workspace}/openapi-connections/"

	payload := strings.NewReader("{\n  \"base_url\": \"<string>\",\n  \"name\": \"<string>\",\n  \"auth_config_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"custom_headers\": [\n    {\n      \"name\": \"<string>\",\n      \"value\": \"\"\n    }\n  ],\n  \"custom_query_params\": [\n    {\n      \"name\": \"<string>\",\n      \"secret\": true,\n      \"value\": \"\"\n    }\n  ],\n  \"description\": \"<string>\",\n  \"spec_content\": {},\n  \"spec_url\": \"<string>\",\n  \"url_variables\": [\n    {\n      \"name\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ]\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/v1/workspaces/{workspace}/openapi-connections/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"base_url\": \"<string>\",\n  \"name\": \"<string>\",\n  \"auth_config_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"custom_headers\": [\n    {\n      \"name\": \"<string>\",\n      \"value\": \"\"\n    }\n  ],\n  \"custom_query_params\": [\n    {\n      \"name\": \"<string>\",\n      \"secret\": true,\n      \"value\": \"\"\n    }\n  ],\n  \"description\": \"<string>\",\n  \"spec_content\": {},\n  \"spec_url\": \"<string>\",\n  \"url_variables\": [\n    {\n      \"name\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/workspaces/{workspace}/openapi-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  \"base_url\": \"<string>\",\n  \"name\": \"<string>\",\n  \"auth_config_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"custom_headers\": [\n    {\n      \"name\": \"<string>\",\n      \"value\": \"\"\n    }\n  ],\n  \"custom_query_params\": [\n    {\n      \"name\": \"<string>\",\n      \"secret\": true,\n      \"value\": \"\"\n    }\n  ],\n  \"description\": \"<string>\",\n  \"spec_content\": {},\n  \"spec_url\": \"<string>\",\n  \"url_variables\": [\n    {\n      \"name\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ]\n}"

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

{
  "available_tools": [
    {
      "description": "<string>",
      "inputSchema": {},
      "name": "<string>"
    }
  ],
  "base_url": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "status": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "auth_config_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "cost": {},
  "custom_headers": [
    {
      "name": "<string>",
      "secret": true,
      "value": "<string>"
    }
  ],
  "custom_query_params": [
    {
      "name": "<string>",
      "secret": true,
      "value": "<string>"
    }
  ],
  "description": "<string>",
  "last_dispatch": {},
  "managed_by": "<string>",
  "registry_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "spec_url": "<string>",
  "url_variables": [
    "<string>"
  ]
}

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

Start here

Concepts

Guides

Self-host

Reference

API reference

API endpoints

Community

Authorizations

Path Parameters

Body

Response