Delete Knowledge Connector

Delete a connector and optionally its synchronized documents. Documents are retained by default. A workspace API key is rejected with 403; use a personal API key.

DELETE/api/v2/knowledge/{id}/connectors/{connectorId}
X-API-Key<token>

Your Sim API key, personal or workspace-scoped. Generate one under Settings, then API Keys. Operations that reject workspace keys say so in their own description.

In: header

Path Parameters

id*string

Knowledge base that owns the connector.

Length1 <= length
connectorId*string

Connector selected for the operation.

Length1 <= length

Query Parameters

workspaceId*string

Workspace that owns the knowledge base.

Length1 <= length <= 128
deleteDocuments?boolean

Also permanently delete documents produced by this connector.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://www.sim.ai/api/v2/knowledge/string/connectors/string?workspaceId=string" \  -H "X-API-Key: YOUR_API_KEY"
{
  "data": {
    "id": "kc-9f8e7d6c",
    "deleted": true,
    "documentsDeleted": 0,
    "documentsKept": 42
  }
}
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "Invalid request"
  }
}
{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "API key required"
  }
}
{
  "error": {
    "code": "FORBIDDEN",
    "message": "Insufficient workspace permissions",
    "details": {
      "code": "INSUFFICIENT_WORKSPACE_ROLE"
    }
  }
}
{
  "error": {
    "code": "NOT_FOUND",
    "message": "Not found"
  }
}
{
  "error": {
    "code": "RATE_LIMITED",
    "message": "API rate limit exceeded",
    "details": {
      "retryAfter": "2026-01-01T00:00:30.000Z"
    }
  }
}
{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "Internal server error"
  }
}
{
  "error": {
    "code": "SERVICE_UNAVAILABLE",
    "message": "Service temporarily unavailable"
  }
}