Enable, disable, or delete many chunks of one document in a single request. Best-effort: an identifier naming no chunk in the document is skipped rather than failing the request, so processed is the authoritative count. Chunks of a connector-synced document are read-only and a write answers 403 with error.details.code: "CONNECTOR_MANAGED_RESOURCE_READ_ONLY" — change the content at the source and re-sync, or exclude the document from the connector. A workspace API key is rejected with 403; use a personal API key.
/api/v2/knowledge/{knowledgeBaseId}/documents/{documentId}/chunksAuthorization
apiKey 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
Unique knowledge document identifier.
1 <= lengthUnique knowledge base identifier.
1 <= lengthRequest Body
application/json
Workspace scope, the operation to apply, and the chunks to apply it to.
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 PATCH "https://www.sim.ai/api/v2/knowledge/string/documents/string/chunks" \ -H "X-API-Key: YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "workspaceId": "a91c4b2e-6d3f-4e8a-b5c7-0d9e2f1a8c64", "operation": "disable", "chunkIds": [ "4c1f9e77-2b3a-4f8d-9e10-6a2c8d4b1e05" ] }'{
"data": {
"operation": "enable",
"processed": 12,
"errors": [
"string"
]
}
}{
"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": "PAYLOAD_TOO_LARGE",
"message": "Request body is too large"
}
}{
"error": {
"code": "UNSUPPORTED_MEDIA_TYPE",
"message": "Request body must be sent as application/json"
}
}{
"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"
}
}