API Reference

Create a connector

View Markdown

POST /api/connectors

Create a connector

Operation IDcreateConnector

Authentication

BearerAuth·http bearer·API key token (envoy_<hex>). Create keys from Settings → API Keys — see Using the API.

Request body

This request body is required.

Content typeapplication/json

requestobject

4 properties

namestringrequired

typestringrequired

Connector type (e.g. sqlite, mongodb, mssql, api, csv)

configobjectrequired

Type-specific configuration

Additional properties are allowed.

descriptionstring

Success response body

201Connector created

Connector created

Content typeapplication/json

responseobject

7 properties

idinteger

namestring

typestring

configobject

Parsed connector configuration

descriptionstring | null

Nullable: yes

created_atstring · date-time

updated_atstring · date-time

Code examples

curl --request POST \
  --url 'https://your-envoy.example.com/api/connectors' \
  --header 'Authorization: Bearer $API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "string",
  "type": "string",
  "config": {}
}'

const response = await fetch("https://your-envoy.example.com/api/connectors", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "string",
    "type": "string",
    "config": {}
  }),
});

if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = response.status === 204 ? null : await response.json();
console.log(data);