Skip to content

Bulk upsert connector documentation

PUT /connector/{slug}/documentation

Documentation is what turns a connector method into a tool: an item with an empty `description` UN-documents that method, and an undocumented method is not offered as a tool. Items must reference methods that exist in the config. An item with neither `resource` nor `method` sets the connector-level description. Sent items are upserted; methods you do not mention are left as they are.

Path Parameters

slugstring
required·

Connector slug of an org-owned connector.

Response Body

resultobject[]
curl -X PUT 'https://api.elaichi.ai/connector/<slug>/documentation' \
  -H 'Authorization: Bearer $ELAICHI_API_TOKEN' \
  -H 'Content-Type: application/json'
const response = await fetch('https://api.elaichi.ai/connector/<slug>/documentation', {
  method: 'PUT',
  headers: {
    'Authorization': 'Bearer ' + process.env.ELAICHI_API_TOKEN,
    'Content-Type': 'application/json',
  },
});

const data = await response.json();
console.log(data);
import os
import requests

url = "https://api.elaichi.ai/connector/<slug>/documentation"
headers = {
    "Authorization": f"Bearer {os.environ['ELAICHI_API_TOKEN']}",
    "Content-Type": "application/json",
}

response = requests.put(url, headers=headers)
print(response.json())