Logo
Search
Docs

List connectors

GET https://app.sulus.ai/api/v1/agents/{agent_id}/connectors

List connectors available to an agent

Authentication

Send a bearer token created on your dashboard's Developer page:

Authorization: Bearer <YOUR_API_KEY>

Path parameters

agent_id string Required

The agent id (UUID).

Validation: uuid (route-constrained)
Stored in ai_projects.uid

Errors

StatusMeaningBody
404 Agent not found, or you do not have access to it
403 You do not have MCP access to this agent. {"message":"You do not have MCP access to this agent."}
401 Missing or invalid bearer token
403 Feature ai_chat not enabled for the account

Notes

  • reachable and the live, per-tool tools list appear only for connectors currently enabled on this agent (enabled: true); a disabled connector shows tools: [] and no reachable key, with tools_count from the connector's cached registry count.
  • server_url is the connector's own tool-server endpoint, not a Sulus URL — it varies per connector.
  • description, purpose, and use_case are the effective values for this agent (agent overlay when set, otherwise the connector defaults). connector_description, connector_purpose, and connector_use_case are the connector defaults. context_overridden is true when any agent overlay column is non-null.
curl --request GET \
  --url https://app.sulus.ai/api/v1/agents/{agent_id}/connectors \
  --header 'Authorization: Bearer <YOUR_API_KEY>'
import requests

url = "https://app.sulus.ai/api/v1/agents/{agent_id}/connectors"
headers = {"Authorization": "Bearer <YOUR_API_KEY>"}

response = requests.get(url, headers=headers)
print(response.json())
package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	url := "https://app.sulus.ai/api/v1/agents/{agent_id}/connectors"
	req, _ := http.NewRequest("GET", url, nil)
	req.Header.Add("Authorization", "Bearer <YOUR_API_KEY>")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
Response 200 
{
    "object": "list",
    "data": [
        {
            "uid": "c3d4e5f6-0000-4000-8000-000000000030",
            "name": "Docs search",
            "description": "Searches the internal knowledge base and returns matching articles.",
            "purpose": "Answer product questions from the knowledge base.",
            "use_case": "When a caller asks how a feature works.",
            "connector_description": "Searches the internal knowledge base and returns matching articles.",
            "connector_purpose": "Answer product questions from the knowledge base.",
            "connector_use_case": "When a caller asks how a feature works.",
            "context_overridden": false,
            "server_key": "docs-search",
            "server_url": "https://connectors.example.com/docs-search/mcp",
            "ghl_location_id": null,
            "enabled": true,
            "tools_count": 2,
            "tools": [
                {
                    "name": "search-docs",
                    "description": "Full-text search over indexed documentation.",
                    "enabled": true
                },
                {
                    "name": "get-doc",
                    "description": "Fetch a single document by id.",
                    "enabled": false
                }
            ],
            "reachable": true
        },
        {
            "uid": "d4e5f6a7-0000-4000-8000-000000000031",
            "name": "Order lookup",
            "description": "Looks up order status by order number or customer email.",
            "purpose": null,
            "use_case": null,
            "connector_description": "Looks up order status by order number or customer email.",
            "connector_purpose": null,
            "connector_use_case": null,
            "context_overridden": false,
            "server_key": "orders",
            "server_url": "https://connectors.example.com/orders/mcp",
            "ghl_location_id": null,
            "enabled": false,
            "tools_count": 3,
            "tools": []
        }
    ]
}