Connector Marketplace API
Use the connector marketplace API to discover available connector types, inspect their config schemas, install tenant-scoped connector instances, and run health checks. This is one of the APIs that becomes more important as teams move from simple LLM chat apps into real multi-agent systems that need governed access to databases, APIs, caches, files, and business platforms.
Overview
Verified routes:
| Method | Path | Purpose |
|---|---|---|
GET | /api/v1/connectors | List connector metadata |
GET | /api/v1/connectors/{id} | Get one connector definition |
POST | /api/v1/connectors/{id}/install | Install a connector |
DELETE | /api/v1/connectors/{id}/uninstall | Uninstall a connector |
GET | /api/v1/connectors/{id}/health | Run a connector health check |
Base URL:
http://localhost:8080
The Agent usually proxies these calls to the Orchestrator.
Authentication and Tenant Scope
Install and uninstall requests need tenant context. In database-backed deployments, tenant_id is required for connector install and uninstall lifecycle operations.
Common headers:
| Header | Use |
|---|---|
Authorization | Basic auth |
| Tenant (from Basic auth) | Tenant scope for install, uninstall, and health checks |
Content-Type | JSON body for installs |
Discovery Responses
The list endpoint returns:
{
"connectors": [],
"total": 0
}
Each connector metadata object includes verified fields such as id, name, type, version, description, category, icon, tags, capabilities, config_schema, installed, and optional healthy plus last_check.
This is the safest way for engineering teams to see what the running build actually exposes before trying to wire a complex agent workflow around databases, APIs, file stores, or SaaS systems.
Install and Uninstall
Verified install request fields:
| Field | Purpose |
|---|---|
connector_id | Request payload field, though path ID is the primary selector |
name | Display name for the instance |
tenant_id | Required in DB-backed installs |
options | Connector-specific options |
credentials | Connector secrets |
Example:
curl -X POST http://localhost:8080/api/v1/connectors/postgresql/install \
-H "Content-Type: application/json" \
-H "Authorization: Basic $(echo -n 'client-id:client-secret' | base64)" \
-d '{
"name": "analytics-db",
"tenant_id": "tenant-123",
"options": {
"host": "analytics.internal",
"port": 5432,
"database": "analytics"
},
"credentials": {
"username": "analytics_user",
"password": "secret"
}
}'
Successful install response:
{
"success": true,
"message": "Connector installed successfully",
"connector_id": "postgresql",
"name": "analytics-db"
}
DELETE /api/v1/connectors/{id}/uninstall returns a similar success / message payload.
Health Checks
GET /api/v1/connectors/{id}/health returns the registry health result for that connector instance. This is the right endpoint for readiness checks before exposing a connector-backed tool to agents in LangGraph, CrewAI, or internal orchestrators.
