{"openapi":"3.1.0","info":{"title":"Databricks SQL (BYOK) API","version":"0.1.0","description":"Databricks SQL (BYOK) lets an AI assistant read your own Databricks SQL data through the Databricks SQL API with a key you supply (personal access token). Read-only: 9 tools (get_sql_warehouse, list_queries, get_query, list_alerts, list_query_history, list_lakeview_dashboards, get_lakeview_dashboard, get_published_lakeview_dashboard, list_genie_spaces). The BYOK key travels with each request, is...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-databricks-sql.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-databricks-sql/docs"},"termsOfService":"https://connectorbay.com/byok-databricks-sql/terms"},"servers":[{"url":"https://byok-databricks-sql.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-databricks-sql/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/get_sql_warehouse":{"post":{"operationId":"get_sql_warehouse","summary":"Get one SQL warehouse: state, size, cluster limits, auto-stop minutes, type, serverless and Photon flags, active session","description":"Get one SQL warehouse: state, size, cluster limits, auto-stop minutes, type, serverless and Photon flags, active sessions and health. Use for \"What size is Databricks SQL warehouse 1a2b3c4d5e6f7a8b and is it running\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"workspace":{"description":"Your AWS Databricks workspace host label: the part before .cloud.databricks.com, for example dbc-a1b2c3d4-e5f6.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Workspace","type":"string"},"warehouse_id":{"description":"Id of the SQL warehouse.","maxLength":200,"title":"Warehouse Id","type":"string"}},"required":["workspace","warehouse_id"],"title":"get_sql_warehouseArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_queries":{"post":{"operationId":"list_queries","summary":"List saved Databricks SQL queries with name, description, owner, warehouse, catalog, schema, tags and update time. The S","description":"List saved Databricks SQL queries with name, description, owner, warehouse, catalog, schema, tags and update time. The SQL text is not included here. Use for \"Which saved SQL queries exist in my Databricks workspace\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"workspace":{"description":"Your AWS Databricks workspace host label: the part before .cloud.databricks.com, for example dbc-a1b2c3d4-e5f6.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Workspace","type":"string"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"Maximum queries per page (1 to 100).","title":"Page Size"},"page_token":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Token from next_page_token of the previous answer; leave empty for the first page.","title":"Page Token"}},"required":["workspace"],"title":"list_queriesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_query":{"post":{"operationId":"get_query","summary":"Get one saved Databricks SQL query: name, description, SQL text, parameters, owner, warehouse and timestamps. Use for \"S","description":"Get one saved Databricks SQL query: name, description, SQL text, parameters, owner, warehouse and timestamps. Use for \"Show the SQL of saved query 1a2b3c4d-0000-0000-0000-000000000000\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"workspace":{"description":"Your AWS Databricks workspace host label: the part before .cloud.databricks.com, for example dbc-a1b2c3d4-e5f6.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Workspace","type":"string"},"query_id":{"description":"Id of the saved query.","maxLength":200,"title":"Query Id","type":"string"}},"required":["workspace","query_id"],"title":"get_queryArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_alerts":{"post":{"operationId":"list_alerts","summary":"List Databricks SQL alerts with name, condition, state, last trigger time, owner and linked query id. Use for \"Which Dat","description":"List Databricks SQL alerts with name, condition, state, last trigger time, owner and linked query id. Use for \"Which Databricks SQL alerts are currently triggered\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"workspace":{"description":"Your AWS Databricks workspace host label: the part before .cloud.databricks.com, for example dbc-a1b2c3d4-e5f6.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Workspace","type":"string"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"Maximum alerts per page (1 to 100).","title":"Page Size"},"page_token":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Token from next_page_token of the previous answer; leave empty for the first page.","title":"Page Token"}},"required":["workspace"],"title":"list_alertsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_query_history":{"post":{"operationId":"list_query_history","summary":"List recent SQL warehouse query executions, newest first, with status, user, warehouse, duration, rows produced, stateme","description":"List recent SQL warehouse query executions, newest first, with status, user, warehouse, duration, rows produced, statement type and error message. Query text is not returned. Use for \"Which queries failed on my Databricks SQL warehouses recently\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"workspace":{"description":"Your AWS Databricks workspace host label: the part before .cloud.databricks.com, for example dbc-a1b2c3d4-e5f6.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Workspace","type":"string"},"status":{"anyOf":[{"enum":["QUEUED","RUNNING","FINISHED","FAILED","CANCELED"],"type":"string"},{"type":"null"}],"default":null,"description":"Only queries with this status.","title":"Status"},"warehouse_id":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only queries that ran on this SQL warehouse id.","title":"Warehouse Id"},"start_time_ms":{"anyOf":[{"maximum":9999999999999,"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Only queries started at or after this time, in epoch milliseconds.","title":"Start Time Ms"},"end_time_ms":{"anyOf":[{"maximum":9999999999999,"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Only queries started at or before this time, in epoch milliseconds.","title":"End Time Ms"},"max_results":{"anyOf":[{"maximum":999,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"Maximum queries per page (under 1000, default 100).","title":"Max Results"},"page_token":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Token from next_page_token of the previous answer; leave empty for the first page.","title":"Page Token"}},"required":["workspace"],"title":"list_query_historyArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_lakeview_dashboards":{"post":{"operationId":"list_lakeview_dashboards","summary":"List AI/BI (Lakeview) dashboards with name, workspace path, warehouse, lifecycle state and timestamps. Use for \"Which AI","description":"List AI/BI (Lakeview) dashboards with name, workspace path, warehouse, lifecycle state and timestamps. Use for \"Which AI/BI dashboards are in my Databricks workspace\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"workspace":{"description":"Your AWS Databricks workspace host label: the part before .cloud.databricks.com, for example dbc-a1b2c3d4-e5f6.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Workspace","type":"string"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"Maximum dashboards per page.","title":"Page Size"},"page_token":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Token from next_page_token of the previous answer; leave empty for the first page.","title":"Page Token"},"show_trashed":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to include dashboards in the trash.","title":"Show Trashed"}},"required":["workspace"],"title":"list_lakeview_dashboardsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_lakeview_dashboard":{"post":{"operationId":"get_lakeview_dashboard","summary":"Get one AI/BI (Lakeview) dashboard definition: name, path, warehouse, lifecycle state, timestamps and the serialized das","description":"Get one AI/BI (Lakeview) dashboard definition: name, path, warehouse, lifecycle state, timestamps and the serialized dashboard JSON (datasets, pages and widgets). Use for \"Show the definition of Lakeview dashboard 01ef0000000000000000000000000000\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"workspace":{"description":"Your AWS Databricks workspace host label: the part before .cloud.databricks.com, for example dbc-a1b2c3d4-e5f6.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Workspace","type":"string"},"dashboard_id":{"description":"UUID of the dashboard.","maxLength":200,"title":"Dashboard Id","type":"string"}},"required":["workspace","dashboard_id"],"title":"get_lakeview_dashboardArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_published_lakeview_dashboard":{"post":{"operationId":"get_published_lakeview_dashboard","summary":"Get the published version of an AI/BI dashboard: name, warehouse, whether credentials are embedded and the revision time","description":"Get the published version of an AI/BI dashboard: name, warehouse, whether credentials are embedded and the revision time. Use for \"Is Lakeview dashboard 01ef0000000000000000000000000000 published\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"workspace":{"description":"Your AWS Databricks workspace host label: the part before .cloud.databricks.com, for example dbc-a1b2c3d4-e5f6.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Workspace","type":"string"},"dashboard_id":{"description":"UUID of the dashboard.","maxLength":200,"title":"Dashboard Id","type":"string"}},"required":["workspace","dashboard_id"],"title":"get_published_lakeview_dashboardArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_genie_spaces":{"post":{"operationId":"list_genie_spaces","summary":"List Genie spaces (natural-language data rooms) with title, description, warehouse and timestamps. Token paginated. Use ","description":"List Genie spaces (natural-language data rooms) with title, description, warehouse and timestamps. Token paginated. Use for \"Which Genie spaces exist in my Databricks workspace\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"workspace":{"description":"Your AWS Databricks workspace host label: the part before .cloud.databricks.com, for example dbc-a1b2c3d4-e5f6.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Workspace","type":"string"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"Maximum spaces per page.","title":"Page Size"},"page_token":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Token from next_page_token of the previous answer; leave empty for the first page.","title":"Page Token"}},"required":["workspace"],"title":"list_genie_spacesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}