> ## Documentation Index
> Fetch the complete documentation index at: https://docs.modulex.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Databricks Integration for AI Agents & Workflows

> Manage Databricks jobs, runs, SQL warehouses, and vector search indexes.

{/* Self-hosted logo — build-time vendored from modulex.json / Iconify (see scripts/lib/logo.js). */}

<img src="https://mintcdn.com/modulexaillc/zKB2qsP6Q61VNLfB/logos/databricks.svg?fit=max&auto=format&n=zKB2qsP6Q61VNLfB&q=85&s=aadd418e0cc1e2c3c581daa2b3fc49a1" alt="Databricks logo" width="72" height="72" data-path="logos/databricks.svg" />

## Overview

Add **Databricks** to any ModuleX agent or workflow. Manage Databricks jobs, runs, SQL warehouses, and vector search indexes via the Databricks REST API (`{domain}.cloud.databricks.com`).

<Info>
  **Categories**: Analytics & Data · Data Engineering · Analytics · Machine Learning · **Auth**: Databricks Personal Access Token · **Actions**: 41
</Info>

## Authentication

### Databricks Personal Access Token

Authenticate using your Databricks workspace domain and a personal access token.

#### Required Credentials

| Field            | Description                                                                  | Required | Format                                 |
| ---------------- | ---------------------------------------------------------------------------- | -------- | -------------------------------------- |
| Workspace Domain | Your Databricks workspace subdomain (the part before .cloud.databricks.com). | Yes      | `my-workspace`                         |
| Access Token     | A Databricks personal access token.                                          | Yes      | `dapi0123456789abcdef0123456789abcdef` |

## Available Actions

<AccordionGroup>
  <Accordion title="cancel_all_runs — Cancel all active runs for a job.">
    ### Parameters

    <ResponseField name="job_id" type="string">
      Identifier of a job. If omitted with all\_queued\_runs=true, cancels all queued runs in the workspace.
    </ResponseField>

    <ResponseField name="all_queued_runs" type="boolean">
      Cancel all queued runs. If no job\_id is provided, all queued runs in the workspace are canceled.
    </ResponseField>

    ### Response

    ```json theme={null}
    {
      "additionalProperties": false,
      "properties": {
        "success": {
          "title": "Success",
          "type": "boolean"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Error"
        }
      },
      "required": [
        "success"
      ],
      "title": "CancelAllRunsOutput",
      "type": "object"
    }
    ```
  </Accordion>

  <Accordion title="cancel_run — Cancel a job run. The run is canceled asynchronously.">
    ### Parameters

    <ResponseField name="run_id" type="string" required>
      Identifier of the run to cancel.
    </ResponseField>

    ### Response

    ```json theme={null}
    {
      "additionalProperties": false,
      "properties": {
        "success": {
          "title": "Success",
          "type": "boolean"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Error"
        }
      },
      "required": [
        "success"
      ],
      "title": "CancelRunOutput",
      "type": "object"
    }
    ```
  </Accordion>

  <Accordion title="create_endpoint — Create a new vector search endpoint.">
    ### Parameters

    <ResponseField name="name" type="string" required>
      The name of the vector search endpoint to create.
    </ResponseField>

    ### Response

    ```json theme={null}
    {
      "additionalProperties": false,
      "properties": {
        "success": {
          "title": "Success",
          "type": "boolean"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Error"
        },
        "data": {
          "anyOf": [
            {
              "additionalProperties": true,
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Data"
        }
      },
      "required": [
        "success"
      ],
      "title": "CreateEndpointOutput",
      "type": "object"
    }
    ```
  </Accordion>

  <Accordion title="create_job — Create a new Databricks job.">
    ### Parameters

    <ResponseField name="tasks" type="string" required>
      JSON string of task specifications for this job.
    </ResponseField>

    <ResponseField name="name" type="string">
      An optional name for the job.
    </ResponseField>

    <ResponseField name="tags" type="string">
      JSON string of tags associated with the job.
    </ResponseField>

    <ResponseField name="job_clusters" type="string">
      JSON string of job cluster specifications.
    </ResponseField>

    <ResponseField name="email_notifications" type="string">
      JSON string of email notification settings.
    </ResponseField>

    <ResponseField name="webhook_notifications" type="string">
      JSON string of webhook notification settings.
    </ResponseField>

    <ResponseField name="timeout_seconds" type="integer">
      Timeout in seconds applied to each run of this job.
    </ResponseField>

    <ResponseField name="schedule" type="string">
      JSON string of schedule definition with quartz\_cron\_expression and timezone\_id.
    </ResponseField>

    <ResponseField name="max_concurrent_runs" type="integer">
      Maximum number of concurrent runs for the job.
    </ResponseField>

    <ResponseField name="git_source" type="string">
      JSON string specifying a remote Git repository for task source code.
    </ResponseField>

    <ResponseField name="access_control_list" type="string">
      JSON string of permissions to set on the job.
    </ResponseField>

    ### Response

    ```json theme={null}
    {
      "additionalProperties": false,
      "properties": {
        "success": {
          "title": "Success",
          "type": "boolean"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Error"
        },
        "job_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Job Id"
        }
      },
      "required": [
        "success"
      ],
      "title": "CreateJobOutput",
      "type": "object"
    }
    ```
  </Accordion>

  <Accordion title="create_sql_warehouse — Create a new SQL Warehouse in Databricks.">
    ### Parameters

    <ResponseField name="name" type="string" required>
      A human-readable name for the warehouse.
    </ResponseField>

    <ResponseField name="cluster_size" type="string" required>
      Size of the cluster: 2X-Small, X-Small, Small, Medium, Large, X-Large, 2X-Large, 3X-Large, 4X-Large.
    </ResponseField>

    <ResponseField name="auto_stop_minutes" type="integer">
      Minutes of inactivity before auto-stop. 0 disables. Must be 0 or >= 10. (Default: `10`)
    </ResponseField>

    <ResponseField name="min_num_clusters" type="integer">
      Minimum number of clusters to maintain. (Default: `1`)
    </ResponseField>

    <ResponseField name="max_num_clusters" type="integer">
      Maximum number of clusters for autoscaling. (Default: `1`)
    </ResponseField>

    <ResponseField name="enable_photon" type="boolean">
      Whether to use Photon optimized clusters.
    </ResponseField>

    <ResponseField name="enable_serverless_compute" type="boolean">
      Whether to use serverless compute.
    </ResponseField>

    <ResponseField name="warehouse_type" type="string">
      Warehouse type: TYPE\_UNSPECIFIED, CLASSIC, or PRO.
    </ResponseField>

    <ResponseField name="spot_instance_policy" type="string">
      Spot instance policy: POLICY\_UNSPECIFIED, COST\_OPTIMIZED, RELIABILITY\_OPTIMIZED.
    </ResponseField>

    <ResponseField name="channel" type="string">
      JSON string of channel details.
    </ResponseField>

    <ResponseField name="tags" type="string">
      JSON string of custom key-value tags.
    </ResponseField>

    ### Response

    ```json theme={null}
    {
      "additionalProperties": false,
      "properties": {
        "success": {
          "title": "Success",
          "type": "boolean"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Error"
        },
        "data": {
          "anyOf": [
            {
              "additionalProperties": true,
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Data"
        }
      },
      "required": [
        "success"
      ],
      "title": "CreateSqlWarehouseOutput",
      "type": "object"
    }
    ```
  </Accordion>

  <Accordion title="create_vector_search_index — Create a new vector search index in Databricks.">
    ### Parameters

    <ResponseField name="name" type="string" required>
      A unique name for the index (e.g., main\_catalog.docs.en\_wiki\_index).
    </ResponseField>

    <ResponseField name="endpoint_name" type="string" required>
      The name of the vector search endpoint.
    </ResponseField>

    <ResponseField name="index_type" type="string" required>
      Type of index: DELTA\_SYNC or DIRECT\_ACCESS.
    </ResponseField>

    <ResponseField name="primary_key" type="string" required>
      The primary key column for the index.
    </ResponseField>

    <ResponseField name="source_table" type="string">
      The Delta table backing the index (required for DELTA\_SYNC).
    </ResponseField>

    <ResponseField name="columns_to_sync" type="string">
      JSON array of column names to sync from the source Delta table.
    </ResponseField>

    <ResponseField name="embedding_source_columns" type="string">
      JSON array of embedding source column configs.
    </ResponseField>

    <ResponseField name="index_schema_json" type="string">
      The schema of the index in JSON format (required for DIRECT\_ACCESS). Sent on the wire as `schema_json`.
    </ResponseField>

    <ResponseField name="pipeline_type" type="string">
      Pipeline type: TRIGGERED or CONTINUOUS. (Default: `TRIGGERED`)
    </ResponseField>

    ### Response

    ```json theme={null}
    {
      "additionalProperties": false,
      "properties": {
        "success": {
          "title": "Success",
          "type": "boolean"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Error"
        },
        "data": {
          "anyOf": [
            {
              "additionalProperties": true,
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Data"
        }
      },
      "required": [
        "success"
      ],
      "title": "CreateVectorSearchIndexOutput",
      "type": "object"
    }
    ```
  </Accordion>

  <Accordion title="delete_endpoint — Delete a vector search endpoint.">
    ### Parameters

    <ResponseField name="endpoint_name" type="string" required>
      The name of the vector search endpoint to delete.
    </ResponseField>

    ### Response

    ```json theme={null}
    {
      "additionalProperties": false,
      "properties": {
        "success": {
          "title": "Success",
          "type": "boolean"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Error"
        }
      },
      "required": [
        "success"
      ],
      "title": "DeleteEndpointOutput",
      "type": "object"
    }
    ```
  </Accordion>

  <Accordion title="delete_job — Delete a job. Deleted jobs cannot be recovered.">
    ### Parameters

    <ResponseField name="job_id" type="string" required>
      Identifier of the job to delete.
    </ResponseField>

    ### Response

    ```json theme={null}
    {
      "additionalProperties": false,
      "properties": {
        "success": {
          "title": "Success",
          "type": "boolean"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Error"
        }
      },
      "required": [
        "success"
      ],
      "title": "DeleteJobOutput",
      "type": "object"
    }
    ```
  </Accordion>

  <Accordion title="delete_run — Delete a non-active run. Returns an error if the run is active.">
    ### Parameters

    <ResponseField name="run_id" type="string" required>
      Identifier of the run to delete.
    </ResponseField>

    ### Response

    ```json theme={null}
    {
      "additionalProperties": false,
      "properties": {
        "success": {
          "title": "Success",
          "type": "boolean"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Error"
        }
      },
      "required": [
        "success"
      ],
      "title": "DeleteRunOutput",
      "type": "object"
    }
    ```
  </Accordion>

  <Accordion title="delete_sql_warehouse — Delete a SQL Warehouse by ID.">
    ### Parameters

    <ResponseField name="warehouse_id" type="string" required>
      The ID of the SQL Warehouse to delete.
    </ResponseField>

    ### Response

    ```json theme={null}
    {
      "additionalProperties": false,
      "properties": {
        "success": {
          "title": "Success",
          "type": "boolean"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Error"
        }
      },
      "required": [
        "success"
      ],
      "title": "DeleteSqlWarehouseOutput",
      "type": "object"
    }
    ```
  </Accordion>

  <Accordion title="delete_vector_search_index — Delete a vector search index.">
    ### Parameters

    <ResponseField name="index_name" type="string" required>
      The name of the vector search index to delete.
    </ResponseField>

    ### Response

    ```json theme={null}
    {
      "additionalProperties": false,
      "properties": {
        "success": {
          "title": "Success",
          "type": "boolean"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Error"
        }
      },
      "required": [
        "success"
      ],
      "title": "DeleteVectorSearchIndexOutput",
      "type": "object"
    }
    ```
  </Accordion>

  <Accordion title="delete_vector_search_index_data — Delete rows from a Direct Access vector index by primary-key values.">
    ### Parameters

    <ResponseField name="index_name" type="string" required>
      The name of the vector search index.
    </ResponseField>

    <ResponseField name="primary_keys" type="string" required>
      JSON array of primary key values to delete.
    </ResponseField>

    ### Response

    ```json theme={null}
    {
      "additionalProperties": false,
      "properties": {
        "success": {
          "title": "Success",
          "type": "boolean"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Error"
        },
        "data": {
          "anyOf": [
            {
              "additionalProperties": true,
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Data"
        }
      },
      "required": [
        "success"
      ],
      "title": "DeleteVectorSearchIndexDataOutput",
      "type": "object"
    }
    ```
  </Accordion>

  <Accordion title="edit_sql_warehouse — Edit the configuration of an existing SQL Warehouse.">
    ### Parameters

    <ResponseField name="warehouse_id" type="string" required>
      The ID of the SQL Warehouse to edit.
    </ResponseField>

    <ResponseField name="name" type="string">
      New logical name for the warehouse.
    </ResponseField>

    <ResponseField name="cluster_size" type="string">
      Size of clusters: 2X-Small, X-Small, Small, Medium, Large, X-Large, 2X-Large, 3X-Large, 4X-Large.
    </ResponseField>

    <ResponseField name="auto_stop_mins" type="integer">
      Minutes of inactivity before auto-stop. 0 disables. Must be 0 or >= 10.
    </ResponseField>

    <ResponseField name="min_num_clusters" type="integer">
      Minimum number of clusters.
    </ResponseField>

    <ResponseField name="max_num_clusters" type="integer">
      Maximum number of clusters for autoscaling.
    </ResponseField>

    <ResponseField name="enable_photon" type="boolean">
      Whether to use Photon optimized clusters.
    </ResponseField>

    <ResponseField name="enable_serverless_compute" type="boolean">
      Whether to use serverless compute.
    </ResponseField>

    <ResponseField name="warehouse_type" type="string">
      Warehouse type: TYPE\_UNSPECIFIED, CLASSIC, or PRO.
    </ResponseField>

    <ResponseField name="spot_instance_policy" type="string">
      Spot instance policy: POLICY\_UNSPECIFIED, COST\_OPTIMIZED, RELIABILITY\_OPTIMIZED.
    </ResponseField>

    <ResponseField name="tags" type="string">
      JSON string of custom key-value tags.
    </ResponseField>

    <ResponseField name="channel" type="string">
      JSON string of channel details.
    </ResponseField>

    ### Response

    ```json theme={null}
    {
      "additionalProperties": false,
      "properties": {
        "success": {
          "title": "Success",
          "type": "boolean"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Error"
        },
        "data": {
          "anyOf": [
            {
              "additionalProperties": true,
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Data"
        }
      },
      "required": [
        "success"
      ],
      "title": "EditSqlWarehouseOutput",
      "type": "object"
    }
    ```
  </Accordion>

  <Accordion title="export_run — Export and retrieve the job run task.">
    ### Parameters

    <ResponseField name="run_id" type="string" required>
      Identifier of the run to export.
    </ResponseField>

    <ResponseField name="views_to_export" type="string">
      Which views to export: CODE, DASHBOARDS, or ALL. Defaults to CODE.
    </ResponseField>

    ### Response

    ```json theme={null}
    {
      "additionalProperties": false,
      "properties": {
        "success": {
          "title": "Success",
          "type": "boolean"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Error"
        },
        "data": {
          "anyOf": [
            {
              "additionalProperties": true,
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Data"
        }
      },
      "required": [
        "success"
      ],
      "title": "ExportRunOutput",
      "type": "object"
    }
    ```
  </Accordion>

  <Accordion title="get_endpoint — Get details of a specific vector search endpoint.">
    ### Parameters

    <ResponseField name="endpoint_name" type="string" required>
      The name of the vector search endpoint.
    </ResponseField>

    ### Response

    ```json theme={null}
    {
      "additionalProperties": false,
      "properties": {
        "success": {
          "title": "Success",
          "type": "boolean"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Error"
        },
        "data": {
          "anyOf": [
            {
              "additionalProperties": true,
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Data"
        }
      },
      "required": [
        "success"
      ],
      "title": "GetEndpointOutput",
      "type": "object"
    }
    ```
  </Accordion>

  <Accordion title="get_job — Retrieve the details for a single job.">
    ### Parameters

    <ResponseField name="job_id" type="string" required>
      Identifier of the job.
    </ResponseField>

    ### Response

    ```json theme={null}
    {
      "additionalProperties": false,
      "properties": {
        "success": {
          "title": "Success",
          "type": "boolean"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Error"
        },
        "data": {
          "anyOf": [
            {
              "additionalProperties": true,
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Data"
        }
      },
      "required": [
        "success"
      ],
      "title": "GetJobOutput",
      "type": "object"
    }
    ```
  </Accordion>

  <Accordion title="get_job_permissions — Get permissions of a job.">
    ### Parameters

    <ResponseField name="job_id" type="string" required>
      Identifier of the job.
    </ResponseField>

    ### Response

    ```json theme={null}
    {
      "additionalProperties": false,
      "properties": {
        "success": {
          "title": "Success",
          "type": "boolean"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Error"
        },
        "data": {
          "anyOf": [
            {
              "additionalProperties": true,
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Data"
        }
      },
      "required": [
        "success"
      ],
      "title": "GetJobPermissionsOutput",
      "type": "object"
    }
    ```
  </Accordion>

  <Accordion title="get_run — Retrieve the metadata of a run.">
    ### Parameters

    <ResponseField name="run_id" type="string" required>
      Identifier of the run.
    </ResponseField>

    <ResponseField name="include_history" type="boolean">
      Whether to include the repair history in the response.
    </ResponseField>

    <ResponseField name="include_resolved_values" type="boolean">
      Whether to include resolved parameter values in the response.
    </ResponseField>

    ### Response

    ```json theme={null}
    {
      "additionalProperties": false,
      "properties": {
        "success": {
          "title": "Success",
          "type": "boolean"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Error"
        },
        "data": {
          "anyOf": [
            {
              "additionalProperties": true,
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Data"
        }
      },
      "required": [
        "success"
      ],
      "title": "GetRunOutput",
      "type": "object"
    }
    ```
  </Accordion>

  <Accordion title="get_run_output — Retrieve the output and metadata of a single task run.">
    ### Parameters

    <ResponseField name="run_id" type="string" required>
      Identifier of the run.
    </ResponseField>

    ### Response

    ```json theme={null}
    {
      "additionalProperties": false,
      "properties": {
        "success": {
          "title": "Success",
          "type": "boolean"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Error"
        },
        "data": {
          "anyOf": [
            {
              "additionalProperties": true,
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Data"
        }
      },
      "required": [
        "success"
      ],
      "title": "GetRunOutputOutput",
      "type": "object"
    }
    ```
  </Accordion>

  <Accordion title="get_sql_warehouse — Retrieve details for a specific SQL Warehouse.">
    ### Parameters

    <ResponseField name="warehouse_id" type="string" required>
      The ID of the SQL Warehouse.
    </ResponseField>

    ### Response

    ```json theme={null}
    {
      "additionalProperties": false,
      "properties": {
        "success": {
          "title": "Success",
          "type": "boolean"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Error"
        },
        "data": {
          "anyOf": [
            {
              "additionalProperties": true,
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Data"
        }
      },
      "required": [
        "success"
      ],
      "title": "GetSqlWarehouseOutput",
      "type": "object"
    }
    ```
  </Accordion>

  <Accordion title="get_sql_warehouse_config — Retrieve the global configuration for SQL Warehouses.">
    ### Response

    ```json theme={null}
    {
      "additionalProperties": false,
      "properties": {
        "success": {
          "title": "Success",
          "type": "boolean"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Error"
        },
        "data": {
          "anyOf": [
            {
              "additionalProperties": true,
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Data"
        }
      },
      "required": [
        "success"
      ],
      "title": "GetSqlWarehouseConfigOutput",
      "type": "object"
    }
    ```
  </Accordion>

  <Accordion title="get_sql_warehouse_permissions — Retrieve the permissions for a specific SQL Warehouse.">
    ### Parameters

    <ResponseField name="warehouse_id" type="string" required>
      The ID of the SQL Warehouse.
    </ResponseField>

    ### Response

    ```json theme={null}
    {
      "additionalProperties": false,
      "properties": {
        "success": {
          "title": "Success",
          "type": "boolean"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Error"
        },
        "data": {
          "anyOf": [
            {
              "additionalProperties": true,
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Data"
        }
      },
      "required": [
        "success"
      ],
      "title": "GetSqlWarehousePermissionsOutput",
      "type": "object"
    }
    ```
  </Accordion>

  <Accordion title="get_vector_search_index — Retrieve details about a specific vector search index.">
    ### Parameters

    <ResponseField name="index_name" type="string" required>
      The name of the vector search index.
    </ResponseField>

    ### Response

    ```json theme={null}
    {
      "additionalProperties": false,
      "properties": {
        "success": {
          "title": "Success",
          "type": "boolean"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Error"
        },
        "data": {
          "anyOf": [
            {
              "additionalProperties": true,
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Data"
        }
      },
      "required": [
        "success"
      ],
      "title": "GetVectorSearchIndexOutput",
      "type": "object"
    }
    ```
  </Accordion>

  <Accordion title="list_endpoints — List all vector search endpoints.">
    ### Parameters

    <ResponseField name="max_results" type="integer">
      Maximum number of endpoints to return. (Default: `100`)
    </ResponseField>

    ### Response

    ```json theme={null}
    {
      "additionalProperties": false,
      "properties": {
        "success": {
          "title": "Success",
          "type": "boolean"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Error"
        },
        "endpoints": {
          "items": {
            "additionalProperties": true,
            "type": "object"
          },
          "title": "Endpoints",
          "type": "array"
        }
      },
      "required": [
        "success"
      ],
      "title": "ListEndpointsOutput",
      "type": "object"
    }
    ```
  </Accordion>

  <Accordion title="list_jobs — List all jobs using automatic pagination.">
    ### Parameters

    <ResponseField name="expand_tasks" type="boolean">
      Whether to include task and cluster details in the response.
    </ResponseField>

    <ResponseField name="name" type="string">
      Optional name to filter on.
    </ResponseField>

    <ResponseField name="max_requests" type="integer">
      Maximum number of API page requests to make (1-10).
    </ResponseField>

    ### Response

    ```json theme={null}
    {
      "additionalProperties": false,
      "properties": {
        "success": {
          "title": "Success",
          "type": "boolean"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Error"
        },
        "jobs": {
          "items": {
            "additionalProperties": true,
            "type": "object"
          },
          "title": "Jobs",
          "type": "array"
        }
      },
      "required": [
        "success"
      ],
      "title": "ListJobsOutput",
      "type": "object"
    }
    ```
  </Accordion>

  <Accordion title="list_runs — List all runs available to the user.">
    ### Parameters

    <ResponseField name="job_id" type="string">
      Identifier of a job to filter runs.
    </ResponseField>

    <ResponseField name="active_only" type="boolean">
      Set to true to return only active runs.
    </ResponseField>

    <ResponseField name="max_results" type="integer">
      Maximum number of runs to return. (Default: `100`)
    </ResponseField>

    ### Response

    ```json theme={null}
    {
      "additionalProperties": false,
      "properties": {
        "success": {
          "title": "Success",
          "type": "boolean"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Error"
        },
        "runs": {
          "items": {
            "additionalProperties": true,
            "type": "object"
          },
          "title": "Runs",
          "type": "array"
        }
      },
      "required": [
        "success"
      ],
      "title": "ListRunsOutput",
      "type": "object"
    }
    ```
  </Accordion>

  <Accordion title="list_sql_warehouses — List all SQL Warehouses available in the workspace.">
    ### Response

    ```json theme={null}
    {
      "additionalProperties": false,
      "properties": {
        "success": {
          "title": "Success",
          "type": "boolean"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Error"
        },
        "warehouses": {
          "items": {
            "additionalProperties": true,
            "type": "object"
          },
          "title": "Warehouses",
          "type": "array"
        }
      },
      "required": [
        "success"
      ],
      "title": "ListSqlWarehousesOutput",
      "type": "object"
    }
    ```
  </Accordion>

  <Accordion title="list_vector_search_indexes — List all vector search indexes for a given endpoint.">
    ### Parameters

    <ResponseField name="endpoint_name" type="string" required>
      The name of the vector search endpoint.
    </ResponseField>

    ### Response

    ```json theme={null}
    {
      "additionalProperties": false,
      "properties": {
        "success": {
          "title": "Success",
          "type": "boolean"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Error"
        },
        "indexes": {
          "items": {
            "additionalProperties": true,
            "type": "object"
          },
          "title": "Indexes",
          "type": "array"
        }
      },
      "required": [
        "success"
      ],
      "title": "ListVectorSearchIndexesOutput",
      "type": "object"
    }
    ```
  </Accordion>

  <Accordion title="query_vector_search_index — Query a specific vector search index.">
    ### Parameters

    <ResponseField name="index_name" type="string" required>
      The name of the vector search index.
    </ResponseField>

    <ResponseField name="columns" type="string" required>
      JSON array of column names to include in the response.
    </ResponseField>

    <ResponseField name="query_text" type="string">
      Free-text query for semantic search.
    </ResponseField>

    <ResponseField name="query_vector" type="string">
      JSON array of floats representing the embedding vector.
    </ResponseField>

    <ResponseField name="filters_json" type="string">
      JSON string representing query filters.
    </ResponseField>

    <ResponseField name="num_results" type="integer">
      Number of results to return. (Default: `10`)
    </ResponseField>

    <ResponseField name="include_embeddings" type="boolean">
      Whether to include embedding vectors in the results.
    </ResponseField>

    ### Response

    ```json theme={null}
    {
      "additionalProperties": false,
      "properties": {
        "success": {
          "title": "Success",
          "type": "boolean"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Error"
        },
        "data": {
          "anyOf": [
            {
              "additionalProperties": true,
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Data"
        }
      },
      "required": [
        "success"
      ],
      "title": "QueryVectorSearchIndexOutput",
      "type": "object"
    }
    ```
  </Accordion>

  <Accordion title="repair_run — Re-run one or more tasks.">
    ### Parameters

    <ResponseField name="run_id" type="string" required>
      Identifier of the run to repair.
    </ResponseField>

    <ResponseField name="rerun_tasks" type="string">
      JSON array of task keys to repair.
    </ResponseField>

    <ResponseField name="rerun_all_failed_tasks" type="boolean">
      If true, repair all failed tasks.
    </ResponseField>

    <ResponseField name="pipeline_params_full_refresh" type="boolean">
      Controls whether the pipeline should perform a full refresh.
    </ResponseField>

    ### Response

    ```json theme={null}
    {
      "additionalProperties": false,
      "properties": {
        "success": {
          "title": "Success",
          "type": "boolean"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Error"
        },
        "repair_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Repair Id"
        }
      },
      "required": [
        "success"
      ],
      "title": "RepairRunOutput",
      "type": "object"
    }
    ```
  </Accordion>

  <Accordion title="reset_job — Overwrite all settings for a job.">
    ### Parameters

    <ResponseField name="job_id" type="string" required>
      Identifier of the job.
    </ResponseField>

    <ResponseField name="new_settings" type="string" required>
      JSON string of the new settings that fully replaces all existing job settings.
    </ResponseField>

    ### Response

    ```json theme={null}
    {
      "additionalProperties": false,
      "properties": {
        "success": {
          "title": "Success",
          "type": "boolean"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Error"
        }
      },
      "required": [
        "success"
      ],
      "title": "ResetJobOutput",
      "type": "object"
    }
    ```
  </Accordion>

  <Accordion title="run_job_now — Run a job now and return the ID of the triggered run.">
    ### Parameters

    <ResponseField name="job_id" type="string" required>
      Identifier of the job to run.
    </ResponseField>

    <ResponseField name="jar_params" type="string">
      JSON array of parameters for jobs with JAR tasks.
    </ResponseField>

    <ResponseField name="notebook_params" type="string">
      JSON object of key-value pairs for notebook tasks.
    </ResponseField>

    <ResponseField name="python_params" type="string">
      JSON array of parameters for Python tasks.
    </ResponseField>

    <ResponseField name="spark_submit_params" type="string">
      JSON array of parameters for spark submit tasks.
    </ResponseField>

    ### Response

    ```json theme={null}
    {
      "additionalProperties": false,
      "properties": {
        "success": {
          "title": "Success",
          "type": "boolean"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Error"
        },
        "run_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Run Id"
        },
        "number_in_job": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Number In Job"
        }
      },
      "required": [
        "success"
      ],
      "title": "RunJobNowOutput",
      "type": "object"
    }
    ```
  </Accordion>

  <Accordion title="scan_vector_search_index — Scan a vector search index and return entries after a given primary key.">
    ### Parameters

    <ResponseField name="index_name" type="string" required>
      The name of the vector search index.
    </ResponseField>

    <ResponseField name="last_primary_key" type="string">
      Primary key of the last entry returned in the previous scan. Leave empty to start from the beginning.
    </ResponseField>

    <ResponseField name="num_results" type="integer">
      Number of results to return. (Default: `10`)
    </ResponseField>

    ### Response

    ```json theme={null}
    {
      "additionalProperties": false,
      "properties": {
        "success": {
          "title": "Success",
          "type": "boolean"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Error"
        },
        "data": {
          "anyOf": [
            {
              "additionalProperties": true,
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Data"
        }
      },
      "required": [
        "success"
      ],
      "title": "ScanVectorSearchIndexOutput",
      "type": "object"
    }
    ```
  </Accordion>

  <Accordion title="set_job_permissions — Set permissions on a job.">
    ### Parameters

    <ResponseField name="job_id" type="string" required>
      Identifier of the job.
    </ResponseField>

    <ResponseField name="access_control_list" type="string" required>
      JSON string of permission objects with user\_name/group\_name/service\_principal\_name and permission\_level.
    </ResponseField>

    ### Response

    ```json theme={null}
    {
      "additionalProperties": false,
      "properties": {
        "success": {
          "title": "Success",
          "type": "boolean"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Error"
        },
        "data": {
          "anyOf": [
            {
              "additionalProperties": true,
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Data"
        }
      },
      "required": [
        "success"
      ],
      "title": "SetJobPermissionsOutput",
      "type": "object"
    }
    ```
  </Accordion>

  <Accordion title="set_sql_warehouse_config — Update the global configuration for SQL Warehouses.">
    ### Parameters

    <ResponseField name="instance_profile_arn" type="string">
      Instance profile ARN for IAM role (AWS).
    </ResponseField>

    <ResponseField name="google_service_account" type="string">
      Service account email for GCP workspaces.
    </ResponseField>

    <ResponseField name="security_policy" type="string">
      Security policy: NONE or DATA\_ACCESS\_CONTROL.
    </ResponseField>

    <ResponseField name="channel" type="string">
      JSON string of channel details.
    </ResponseField>

    <ResponseField name="enabled_warehouse_types" type="string">
      JSON array of enabled warehouse type objects.
    </ResponseField>

    <ResponseField name="config_param" type="string">
      JSON array of general config key/value pairs.
    </ResponseField>

    <ResponseField name="global_param" type="string">
      JSON array of global parameter key/value pairs.
    </ResponseField>

    ### Response

    ```json theme={null}
    {
      "additionalProperties": false,
      "properties": {
        "success": {
          "title": "Success",
          "type": "boolean"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Error"
        },
        "data": {
          "anyOf": [
            {
              "additionalProperties": true,
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Data"
        }
      },
      "required": [
        "success"
      ],
      "title": "SetSqlWarehouseConfigOutput",
      "type": "object"
    }
    ```
  </Accordion>

  <Accordion title="set_sql_warehouse_permissions — Update the permissions for a specific SQL Warehouse.">
    ### Parameters

    <ResponseField name="warehouse_id" type="string" required>
      The ID of the SQL Warehouse.
    </ResponseField>

    <ResponseField name="access_control_list" type="string" required>
      JSON string of access control entries with user\_name/group\_name/service\_principal\_name and permission\_level.
    </ResponseField>

    ### Response

    ```json theme={null}
    {
      "additionalProperties": false,
      "properties": {
        "success": {
          "title": "Success",
          "type": "boolean"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Error"
        },
        "data": {
          "anyOf": [
            {
              "additionalProperties": true,
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Data"
        }
      },
      "required": [
        "success"
      ],
      "title": "SetSqlWarehousePermissionsOutput",
      "type": "object"
    }
    ```
  </Accordion>

  <Accordion title="start_sql_warehouse — Start a SQL Warehouse by ID.">
    ### Parameters

    <ResponseField name="warehouse_id" type="string" required>
      The ID of the SQL Warehouse to start.
    </ResponseField>

    ### Response

    ```json theme={null}
    {
      "additionalProperties": false,
      "properties": {
        "success": {
          "title": "Success",
          "type": "boolean"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Error"
        }
      },
      "required": [
        "success"
      ],
      "title": "StartSqlWarehouseOutput",
      "type": "object"
    }
    ```
  </Accordion>

  <Accordion title="stop_sql_warehouse — Stop a SQL Warehouse by ID.">
    ### Parameters

    <ResponseField name="warehouse_id" type="string" required>
      The ID of the SQL Warehouse to stop.
    </ResponseField>

    ### Response

    ```json theme={null}
    {
      "additionalProperties": false,
      "properties": {
        "success": {
          "title": "Success",
          "type": "boolean"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Error"
        }
      },
      "required": [
        "success"
      ],
      "title": "StopSqlWarehouseOutput",
      "type": "object"
    }
    ```
  </Accordion>

  <Accordion title="sync_vector_search_index — Synchronize a Delta Sync vector search index.">
    ### Parameters

    <ResponseField name="index_name" type="string" required>
      The name of the vector search index to synchronize.
    </ResponseField>

    ### Response

    ```json theme={null}
    {
      "additionalProperties": false,
      "properties": {
        "success": {
          "title": "Success",
          "type": "boolean"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Error"
        },
        "data": {
          "anyOf": [
            {
              "additionalProperties": true,
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Data"
        }
      },
      "required": [
        "success"
      ],
      "title": "SyncVectorSearchIndexOutput",
      "type": "object"
    }
    ```
  </Accordion>

  <Accordion title="update_job — Update an existing job. Only the fields provided will be updated.">
    ### Parameters

    <ResponseField name="job_id" type="string" required>
      Identifier of the job to update.
    </ResponseField>

    <ResponseField name="new_settings" type="string" required>
      JSON string of updated job settings (only fields to change).
    </ResponseField>

    <ResponseField name="fields_to_remove" type="string">
      JSON array of field paths to remove from the job settings.
    </ResponseField>

    ### Response

    ```json theme={null}
    {
      "additionalProperties": false,
      "properties": {
        "success": {
          "title": "Success",
          "type": "boolean"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Error"
        }
      },
      "required": [
        "success"
      ],
      "title": "UpdateJobOutput",
      "type": "object"
    }
    ```
  </Accordion>

  <Accordion title="upsert_vector_search_index_data — Upsert data into an existing vector search index.">
    ### Parameters

    <ResponseField name="index_name" type="string" required>
      The name of the vector search index.
    </ResponseField>

    <ResponseField name="inputs_json" type="string" required>
      JSON array of row objects to upsert.
    </ResponseField>

    ### Response

    ```json theme={null}
    {
      "additionalProperties": false,
      "properties": {
        "success": {
          "title": "Success",
          "type": "boolean"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Error"
        },
        "data": {
          "anyOf": [
            {
              "additionalProperties": true,
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Data"
        }
      },
      "required": [
        "success"
      ],
      "title": "UpsertVectorSearchIndexDataOutput",
      "type": "object"
    }
    ```
  </Accordion>
</AccordionGroup>

## Limits & Quotas

* Databricks API rate limits vary by endpoint and workspace tier. Consult your workspace admin for specific limits.
* Jobs API: typically 30 requests/second per workspace.
* Vector Search API: limits depend on endpoint configuration and provisioned capacity.
* SQL Warehouses API: standard REST API limits apply.
* Error model: non-2xx responses are caught and returned as `success=False` + `error` rather than raising.

## Related integrations

<CardGroup cols={3}>
  <Card title="Google Tag Manager" href="/integrations/tools/google-tag-manager" />

  <Card title="Microsoft Power BI" href="/integrations/tools/microsoft-power-bi" />

  <Card title="Mixpanel" href="/integrations/tools/mixpanel" />
</CardGroup>

## Links

* [Databricks](https://www.databricks.com)