Knowledge Assistants
manage_kaCreate, update, delete, and query Databricks Knowledge Assistants; manage document sources, examples, syncs, and permissions for Q&A over Unity Catalog data.
Instructions
Manage Knowledge Assistants (Agent Bricks document Q&A agents over UC volumes, tables or vector indexes).
Actions:
list / get / delete; create (spec: display_name, description, instructions); update (spec fields among display_name, description, instructions).
list_sources / get_source / delete_source; add_source (spec: display_name, description, source_type 'files'|'index'|'file_table' plus files={path:'/Volumes/...'} or index={index_name,text_col,doc_uri_col} or file_table={table_name,file_col}); update_source (display_name, description); sync_sources re-ingests non-index sources.
list_examples / get_example / add_example (spec: question, guidelines) / update_example / delete_example.
get_permissions / update_permissions (spec: access_control_list). Query an assistant through its serving endpoint (manage_serving_endpoint action=query).
Safety classification: list, get, list_sources, get_source, list_examples, get_example = READ_ONLY; create, update, add_source, update_source, add_example, update_example = WRITE; delete, delete_source, delete_example = DESTRUCTIVE; sync_sources = EXECUTION+WRITE; get_permissions = READ_ONLY+SECURITY_SENSITIVE; update_permissions = SECURITY_SENSITIVE+WRITE.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| spec | No | Request body fields for create/update, using the Databricks REST API field names (snake_case). Unknown fields are rejected. | |
| action | Yes | Operation to perform. | |
| confirm | No | Set to true ONLY after the user has reviewed the plan returned by a previous call with status 'confirmation_required'. Required for destructive/security-sensitive actions. | |
| dry_run | No | If true, validate and return the planned change without executing it. | |
| page_size | No | Max items to return (server caps this). | |
| source_id | No | Knowledge source id (or full resource name). | |
| example_id | No | Example id (or full resource name). | |
| page_token | No | next_page_token from a previous response. | |
| update_mask | No | Comma-separated fields to update; defaults to the keys present in spec. | |
| knowledge_assistant_id | No | Knowledge Assistant id or resource name 'knowledge-assistants/{id}'. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | No | ||
| page | No | ||
| plan | No | ||
| tool | Yes | ||
| action | No | ||
| safety | No | ||
| status | No | success | |
| summary | Yes | ||
| warnings | No | ||
| next_steps | No | Suggested follow-up calls. | |
| request_id | No |