Validate and connect an external source, then queue its initial synchronization. The apiKey field is write-only and is never returned. A workspace API key is rejected with 403; use a personal API key.
POST
/api/v2/knowledge/{id}/connectorsAuthorization
apiKey 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
Unique knowledge base identifier.
Length
1 <= lengthRequest Body
application/json
Workspace, connector type, authentication reference, source configuration, and sync schedule.
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://www.sim.ai/api/v2/knowledge/string/connectors" \ -H "X-API-Key: YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "workspaceId": "a91c4b2e-6d3f-4e8a-b5c7-0d9e2f1a8c64", "connectorType": "notion", "credentialId": "cred-4b3a2c1d", "sourceConfig": { "pageIds": [ "page-123" ] }, "syncIntervalMinutes": 1440 }'{
"data": {
"id": "kc-9f8e7d6c",
"knowledgeBaseId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"connectorType": "notion",
"credentialId": "cred-4b3a2c1d",
"sourceConfig": {
"pageIds": [
"page-123"
]
},
"syncMode": "full",
"syncIntervalMinutes": 1440,
"status": "active",
"lastSyncAt": "2026-06-20T14:02:11.000Z",
"lastSyncError": null,
"lastSyncDocCount": 42,
"nextSyncAt": "2026-06-21T14:02:11.000Z",
"consecutiveFailures": 0,
"createdAt": "2026-06-01T09:14:00.000Z",
"updatedAt": "2026-06-20T14:02:11.000Z"
}
}{
"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": "CONFLICT",
"message": "Upload has already been completed"
}
}{
"error": {
"code": "PAYLOAD_TOO_LARGE",
"message": "Request body is too large"
}
}{
"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"
}
}