Tool

View as Markdown

Tool object

namestringBeta: Full resource name: supervisor-agents/{supervisor_agent_id}/tools/{tool_id}

idstringBeta: Deprecated: Use tool_id instead.

tool_typestringBeta: Tool type. Must be one of: "genie_space", "knowledge_assistant", "uc_function", "uc_connection", "uc_mcp", "app", "volume", "dashboard", "serving_endpoint", "table", "vector_search_index", "catalog", "schema", "supervisor_agent", "databricks_web_search", "skill". The legacy values "lakeview_dashboard", "uc_table", and "web_search" are also accepted and remain equivalent to "dashboard", "table", and "databricks_web_search" respectively. The "databricks_web_search" tool_type maps to the web_search spec field.

genie_spaceobjectBeta

Show child attributesHide child attributes

idstringBeta: Deprecated: use space_id instead. Still REQUIRED for backward compatibility until a future API version removes it.

knowledge_assistantobjectBeta

Show child attributesHide child attributes

serving_endpoint_namestringBeta: Deprecated: use knowledge_assistant_id instead.

knowledge_assistant_idstringBeta: The ID of the knowledge assistant.

uc_functionobjectBeta

Show child attributesHide child attributes

namestringBeta: Full uc function name

appobjectBeta

Show child attributesHide child attributes

namestringBeta: App name

volumeobjectBeta

Show child attributesHide child attributes

namestringBeta: Full uc volume name

uc_connectionobjectBeta

Show child attributesHide child attributes

namestringBeta

descriptionstringBeta: Description of what this tool does (user-facing).

tool_idstringBeta: User specified id of the Tool.

View as Markdown

The Tool object

{
  "name": "string",
  "id": "string",
  "tool_type": "string",
  "genie_space": {
    "id": "string"
  },
  "knowledge_assistant": {
    "serving_endpoint_name": "string",
    "knowledge_assistant_id": "string"
  },
  "uc_function": {
    "name": "string"
  },
  "app": {
    "name": "string"
  },
  "volume": {
    "name": "string"
  },
  "uc_connection": {
    "name": "string"
  },
  "description": "string",
  "tool_id": "string"
}

Get Beta

GET /api/2.1/{name=supervisor-agents/*/tools/*}

Gets a Tool.

API scopes: supervisor-agents

Parameters

namestringpath: The resource name of the Tool. Format: supervisor-agents/{supervisor_agent_id}/tools/{tool_id}

Response

Returns the Tool object.

View as Markdown

Response

{
  "name": "string",
  "id": "string",
  "tool_type": "string",
  "genie_space": {
    "id": "string"
  },
  "knowledge_assistant": {
    "serving_endpoint_name": "string",
    "knowledge_assistant_id": "string"
  },
  "uc_function": {
    "name": "string"
  },
  "app": {
    "name": "string"
  },
  "volume": {
    "name": "string"
  },
  "uc_connection": {
    "name": "string"
  },
  "description": "string",
  "tool_id": "string"
}

List Beta

GET /api/2.1/{parent=supervisor-agents/*}/tools

Lists Tools under a Supervisor Agent.

API scopes: supervisor-agents

Parameters

parentstringpath: Parent resource to list from. Format: supervisor-agents/{supervisor_agent_id}

page_sizeint32query: Constraints: [ 1 .. 100 ]

page_tokenstringquery

Response

Returns a list of Tool objects.

View as Markdown

Response

{
  "tools": [
    {
      "name": "string",
      "id": "string",
      "tool_type": "string",
      "genie_space": {},
      "knowledge_assistant": {},
      "uc_function": {},
      "app": {},
      "volume": {},
      "uc_connection": {},
      "description": "string",
      "tool_id": "string"
    }
  ],
  "next_page_token": "string"
}

Create Beta

POST /api/2.1/{parent=supervisor-agents/*}/tools

Creates a Tool under a Supervisor Agent. Specify one of "genie_space", "knowledge_assistant", "uc_function", "uc_connection", "app", "volume", "dashboard", "table", "vector_search_index", "catalog", "schema", "supervisor_agent", "databricks_web_search", "skill" in the request body. The legacy values "lakeview_dashboard", "uc_table", and "web_search" are also accepted and remain equivalent to "dashboard", "table", and "databricks_web_search" respectively. The "databricks_web_search" tool_type maps to the web_search spec field.

API scopes: supervisor-agents

Parameters

parentstringpath: Parent resource where this tool will be created. Format: supervisor-agents/{supervisor_agent_id}

tool_idstringquery: The ID to use for the tool, which will become the final component of the tool's resource name.
Constraints: [ 4 .. 63 ] characters

Request body

toolobject

Show child attributesHide child attributes

namestring: Full resource name: supervisor-agents/{supervisor_agent_id}/tools/{tool_id}

idstring: Deprecated: Use tool_id instead.

tool_typestring: Tool type. Must be one of: "genie_space", "knowledge_assistant", "uc_function", "uc_connection", "uc_mcp", "app", "volume", "dashboard", "serving_endpoint", "table", "vector_search_index", "catalog", "schema", "supervisor_agent", "databricks_web_search", "skill". The legacy values "lakeview_dashboard", "uc_table", and "web_search" are also accepted and remain equivalent to "dashboard", "table", and "databricks_web_search" respectively. The "databricks_web_search" tool_type maps to the web_search spec field.

genie_spaceobjectRequired

Show child attributesHide child attributes

idstring: Deprecated: use space_id instead. Still REQUIRED for backward compatibility until a future API version removes it.

knowledge_assistantobjectRequired

Show child attributesHide child attributes

serving_endpoint_namestring: Deprecated: use knowledge_assistant_id instead.

knowledge_assistant_idstring: The ID of the knowledge assistant.

uc_functionobjectRequired

Show child attributesHide child attributes

namestring: Full uc function name

appobjectRequired

Show child attributesHide child attributes

namestring: App name

volumeobjectRequired

Show child attributesHide child attributes

namestring: Full uc volume name

uc_connectionobjectRequired

Show child attributesHide child attributes

namestring

descriptionstring: Description of what this tool does (user-facing).

tool_idstring: User specified id of the Tool.

Response

Returns the Tool object.

View as Markdown

Request

{
  "tool": {
    "name": "string",
    "id": "string",
    "tool_type": "string",
    "genie_space": {},
    "knowledge_assistant": {},
    "uc_function": {},
    "app": {},
    "volume": {},
    "uc_connection": {},
    "description": "string",
    "tool_id": "string"
  }
}

Response

{
  "name": "string",
  "id": "string",
  "tool_type": "string",
  "genie_space": {
    "id": "string"
  },
  "knowledge_assistant": {
    "serving_endpoint_name": "string",
    "knowledge_assistant_id": "string"
  },
  "uc_function": {
    "name": "string"
  },
  "app": {
    "name": "string"
  },
  "volume": {
    "name": "string"
  },
  "uc_connection": {
    "name": "string"
  },
  "description": "string",
  "tool_id": "string"
}

Update Beta

PATCH /api/2.1/{tool.name=supervisor-agents/*/tools/*}

Updates a Tool. Only the description field can be updated. To change immutable fields such as tool type, spec, or tool ID, delete the tool and recreate it.

API scopes: supervisor-agents

Parameters

toolobjectpath

The Tool to update.

Show child attributesHide child attributes

namestring: Full resource name: supervisor-agents/{supervisor_agent_id}/tools/{tool_id}

idstring: Deprecated: Use tool_id instead.

tool_typestring: Tool type. Must be one of: "genie_space", "knowledge_assistant", "uc_function", "uc_connection", "uc_mcp", "app", "volume", "dashboard", "serving_endpoint", "table", "vector_search_index", "catalog", "schema", "supervisor_agent", "databricks_web_search", "skill". The legacy values "lakeview_dashboard", "uc_table", and "web_search" are also accepted and remain equivalent to "dashboard", "table", and "databricks_web_search" respectively. The "databricks_web_search" tool_type maps to the web_search spec field.

genie_spaceobjectRequired

Show child attributesHide child attributes

idstring: Deprecated: use space_id instead. Still REQUIRED for backward compatibility until a future API version removes it.

knowledge_assistantobjectRequired

Show child attributesHide child attributes

serving_endpoint_namestring: Deprecated: use knowledge_assistant_id instead.

knowledge_assistant_idstring: The ID of the knowledge assistant.

uc_functionobjectRequired

Show child attributesHide child attributes

namestring: Full uc function name

appobjectRequired

Show child attributesHide child attributes

namestring: App name

volumeobjectRequired

Show child attributesHide child attributes

namestring: Full uc volume name

uc_connectionobjectRequired

Show child attributesHide child attributes

namestring

descriptionstring: Description of what this tool does (user-facing).

tool_idstring: User specified id of the Tool.

update_maskstringquery: Field mask for fields to be updated.

Response

Returns the Tool object.

View as Markdown

Response

{
  "name": "string",
  "id": "string",
  "tool_type": "string",
  "genie_space": {
    "id": "string"
  },
  "knowledge_assistant": {
    "serving_endpoint_name": "string",
    "knowledge_assistant_id": "string"
  },
  "uc_function": {
    "name": "string"
  },
  "app": {
    "name": "string"
  },
  "volume": {
    "name": "string"
  },
  "uc_connection": {
    "name": "string"
  },
  "description": "string",
  "tool_id": "string"
}

Delete Beta

DELETE /api/2.1/{name=supervisor-agents/*/tools/*}

Deletes a Tool.

API scopes: supervisor-agents

Parameters

namestringpath: The resource name of the Tool. Format: supervisor-agents/{supervisor_agent_id}/tools/{tool_id}

Tool object​

Get Beta​

Parameters​

Response​

List Beta​

Parameters​

Response​

Create Beta​

Parameters​

Request body​

Response​

Update Beta​

Parameters​

Response​

Delete Beta​

Parameters​

Tool object

Get Beta

Parameters

Response

List Beta

Parameters

Response

Create Beta

Parameters

Request body

Response

Update Beta

Parameters

Response

Delete Beta

Parameters