### Example Response for Get Example

Source: https://docs.databricks.com/api/workspace/knowledgeassistants/getexample

This is a sample JSON response for a successful request to retrieve an example from a Knowledge Assistant.

```json
{
  "create_time": "2019-08-24T14:15:22Z",
  "example_id": "string",
  "guidelines": [
    "string"
  ],
  "name": "string",
  "question": "string",
  "update_time": "2019-08-24T14:15:22Z"
}
```

--------------------------------

### List All Consumer Installations Response Sample

Source: https://docs.databricks.com/api/workspace/consumerinstallations/list

Example JSON response for the 'List All Consumer Installations' API call, showing the structure of installation data and pagination information.

```json
{
  "installations": [
    {
      "catalog_name": "string",
      "error_message": "string",
      "id": "string",
      "installed_on": 0,
      "listing_id": "string",
      "listing_name": "string",
      "recipient_type": "DELTA_SHARING_RECIPIENT_TYPE_DATABRICKS",
      "repo_name": "string",
      "repo_path": "string",
      "share_name": "string",
      "status": "INSTALLED",
      "token_detail": {
        "bearerToken": "string",
        "endpoint": "string",
        "expirationTime": "string",
        "shareCredentialsVersion": 0
      },
      "tokens": [
        {
          "activation_url": "string",
          "created_at": 0,
          "created_by": "string",
          "expiration_time": 0,
          "id": "string",
          "updated_at": 0,
          "updated_by": "string"
        }
      ]
    }
  ],
  "next_page_token": "string"
}
```

--------------------------------

### Get an example from a Knowledge Assistant

Source: https://docs.databricks.com/api/workspace/knowledgeassistants/getexample

Retrieves a specific example from a Databricks Knowledge Assistant. Requires the full resource name of the example.

```bash
GET /api/2.1/{name=knowledge-assistants/*/examples/*}
```

--------------------------------

### Get an example from a Knowledge Assistant

Source: https://docs.databricks.com/api/workspace/knowledgeassistants/createknowledgeassistant

Retrieves details for a specific example by its ID.

```APIDOC
## GET /api/2.0/knowledge-assistants/{assistant_id}/examples/{example_id}

### Description
Retrieves details for a specific example by its ID.

### Method
GET

### Endpoint
/api/2.0/knowledge-assistants/{assistant_id}/examples/{example_id}

### Parameters
#### Path Parameters
- **assistant_id** (string) - Required - The ID of the Knowledge Assistant.
- **example_id** (string) - Required - The ID of the example to retrieve.

### Response
#### Success Response (200)
- **example_id** (string) - The ID of the example.
- **assistant_id** (string) - The ID of the Knowledge Assistant.
- **query** (string) - The user's query for the example.
- **response** (string) - The expected response from the assistant.
- **metadata** (object) - Metadata associated with the example.

#### Response Example
{
  "example_id": "ex_a1b2c3d4e5",
  "assistant_id": "asst_12345abcde",
  "query": "What are your operating hours?",
  "response": "We are open from 9 AM to 5 PM, Monday to Friday.",
  "metadata": {
    "category": "Operating Hours"
  }
}
```

--------------------------------

### Update Installation Response Body Example

Source: https://docs.databricks.com/api/workspace/consumerinstallations/update

This JSON object represents a successful response after updating an installation. It returns the updated installation details, including status and token information.

```json
{
  "installation": {
    "catalog_name": "string",
    "error_message": "string",
    "id": "string",
    "installed_on": 0,
    "listing_id": "string",
    "listing_name": "string",
    "recipient_type": "DELTA_SHARING_RECIPIENT_TYPE_DATABRICKS | DELTA_SHARING_RECIPIENT_TYPE_OPEN",
    "repo_name": "string",
    "repo_path": "string",
    "share_name": "string",
    "status": "INSTALLED | FAILED",
    "token_detail": {
      "tokens": [
        {
          "token": "string"
        }
      ]
    }
  }
}
```

--------------------------------

### List Installations for a Listing

Source: https://docs.databricks.com/api/workspace/consumerinstallations/listlistinginstallations

Use this GET request to retrieve all installations for a specific Marketplace listing. It requires the `listing_id` and supports pagination with `page_token` and `page_size`.

```bash
GET /api/2.1/marketplace-consumer/listings/{listing_id}/installations
```

--------------------------------

### Get an example from a Supervisor Agent

Source: https://docs.databricks.com/api/workspace/supervisoragents/listsupervisoragents

Retrieves a specific example from a supervisor agent.

```APIDOC
## Get an Example from a Supervisor Agent

### Description
Retrieves a specific example from a supervisor agent.

### Method
GET

### Endpoint
/api/2.0/supervisor-agents/agents/{agent_id}/examples/{example_id}

### Parameters
#### Path Parameters
- **agent_id** (string) - Required - The ID of the supervisor agent.
- **example_id** (string) - Required - The ID of the example to retrieve.

### Response
#### Success Response (200)
- **example** (object) - The example object with its details.
```

--------------------------------

### Get an Example from a Knowledge Assistant

Source: https://docs.databricks.com/api/workspace/knowledgeassistants/getknowledgeassistant

Retrieves a specific example from a Knowledge Assistant.

```APIDOC
## GET /api/2.0/knowledge-assistants/{assistant_id}/examples/{example_id}

### Description
Retrieves a specific example from a Knowledge Assistant.

### Method
GET

### Endpoint
/api/2.0/knowledge-assistants/{assistant_id}/examples/{example_id}

### Parameters
#### Path Parameters
- **assistant_id** (string) - Required - The ID of the Knowledge Assistant.
- **example_id** (string) - Required - The ID of the example.
```

--------------------------------

### Get an example from a Knowledge Assistant

Source: https://docs.databricks.com/api/workspace/knowledgeassistants/getexample

Retrieves a specific example from a Knowledge Assistant. This is useful for fetching example details for display or further processing.

```APIDOC
## Get an example from a Knowledge Assistant
Beta
`
GET
/api/2.1/{name=knowledge-assistants/*/examples/*}`
Gets an example from a Knowledge Assistant.
API scopes:`knowledge-assistants`
### Path parameters
`name`requiredstring
The resource name of the example. Format: knowledge-assistants/{knowledge_assistant_id}/examples/{example_id}
### Responses
**200** Request completed successfully.
Request completed successfully.
`create_time`date-time
Timestamp when this example was created.
`example_id`string
The universally unique identifier (UUID) of the example.
`guidelines`Array of string
Guidelines for answering the question. Optional — examples may be created with just a question; the front-end form does not require guidelines.
`name`stringIDImmutable
Full resource name: knowledge-assistants/{knowledge_assistant_id}/examples/{example_id}
`question`string
The example question.
`update_time`date-time
Timestamp when this example was last updated.
# Response samples
200
{
"create_time": "2019-08-24T14:15:22Z",
"example_id": "string",
"guidelines": [
"string"
],
"name": "string",
"question": "string",
"update_time": "2019-08-24T14:15:22Z"
}
```

--------------------------------

### Get an example from a Supervisor Agent

Source: https://docs.databricks.com/api/workspace/supervisoragents/getexample

Retrieves a specific example associated with a supervisor agent. This includes the example's ID, guidelines, name, and the question it represents.

```APIDOC
## GET /api/2.1/{name=supervisor-agents/*/examples/*}

### Description
Gets an example from a Supervisor Agent.

### Method
GET

### Endpoint
/api/2.1/{name=supervisor-agents/*/examples/*}

### Parameters
#### Path Parameters
- **name** (string) - Required - The resource name of the example. Format: supervisor-agents/{supervisor_agent_id}/examples/{example_id}

### Responses
#### Success Response (200)
- **example_id** (string) - The universally unique identifier (UUID) of the example.
- **guidelines** (Array of string) - Guidelines for answering the question.
- **name** (string) - IDImmutable - Full resource name: supervisor-agents/{supervisor_agent_id}/examples/{example_id}
- **question** (string) - The example question.

#### Response Example
```json
{
  "example_id": "string",
  "guidelines": [
    "string"
  ],
  "name": "string",
  "question": "string"
}
```
```

--------------------------------

### Example Response for Listing Supervisor Agent Examples

Source: https://docs.databricks.com/api/workspace/supervisoragents/listexamples

This is a sample JSON response when successfully listing examples for a Supervisor Agent. It includes an array of example objects, each with an ID, guidelines, name, and question. The `next_page_token` indicates if more results are available.

```json
{
  "examples": [
    {
      "example_id": "string",
      "guidelines": [
        "string"
      ],
      "name": "string",
      "question": "string"
    }
  ],
  "next_page_token": "string"
}
```

--------------------------------

### Start a Pipeline

Source: https://docs.databricks.com/api/workspace/pipelines/get

Starts a pipeline.

```APIDOC
## POST /pipelines/{pipeline_id}/start

### Description
Starts a pipeline.

### Method
POST

### Endpoint
/pipelines/{pipeline_id}/start
```

--------------------------------

### Start App

Source: https://docs.databricks.com/api/workspace/apps/getdeployment

Starts a specific app.

```APIDOC
## POST /apps/{app_id}/start

### Description
Starts a specific app.

### Method
POST

### Endpoint
/apps/{app_id}/start

### Parameters
#### Path Parameters
- **app_id** (string) - Required - The ID of the app.
```

--------------------------------

### Create Knowledge Assistant Example API

Source: https://docs.databricks.com/api/workspace/knowledgeassistants/createexample

Use this POST request to create a new example for a Knowledge Assistant. The request body must include the parent resource ID and the example question. Guidelines are optional.

```bash
POST
/api/2.1/{parent=knowledge-assistants/*}/examples
```

--------------------------------

### Install from a listing

Source: https://docs.databricks.com/api/workspace/consumerinstallations

Installs a Databricks Marketplace listing for a consumer.

```APIDOC
## Install from a listing

### Description
Installs a Databricks Marketplace listing for a consumer.

### Method
POST

### Endpoint
/api/marketplace/v1/consumer/installations

### Request Body
- **listing_id** (string) - Required - The ID of the listing to install.
- **installation_name** (string) - Required - The name for the installation.
```

--------------------------------

### Start an app

Source: https://docs.databricks.com/api/workspace/apps

Starts a previously created and configured app.

```APIDOC
## Start an app

### Description
Starts a previously created and configured app.

### Method
POST

### Endpoint
/api/2.0/apps/{app_id}/start

### Parameters
#### Path Parameters
- **app_id** (string) - Required - The unique identifier of the app to start.

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating the app has started.
```

--------------------------------

### List Examples for a Supervisor Agent

Source: https://docs.databricks.com/api/workspace/supervisoragents/listexamples

Use this endpoint to retrieve a list of examples associated with a specific Supervisor Agent. You can control the number of results per page using `page_size` and paginate through results using `page_token`.

```bash
GET /api/2.1/{parent=supervisor-agents/*}/examples
```

--------------------------------

### List Examples

Source: https://docs.databricks.com/api/workspace/knowledgeassistants/listexamples

Lists examples under a Knowledge Assistant. This is a beta endpoint.

```APIDOC
## GET /api/2.1/{parent=knowledge-assistants/*}/examples

### Description
Lists examples under a Knowledge Assistant.

### Method
GET

### Endpoint
/api/2.1/{parent=knowledge-assistants/*}/examples

### Parameters
#### Path Parameters
- **parent** (string) - Required - Parent resource to list from. Format: knowledge-assistants/{knowledge_assistant_id}

#### Query Parameters
- **page_size** (int32) - Optional - The maximum number of examples to return. If unspecified, at most 100 examples will be returned. The maximum value is 100; values above 100 will be coerced to 100.
- **page_token** (string) - Optional - A page token, received from a previous `ListExamples` call. Provide this to retrieve the subsequent page. If unspecified, the first page will be returned.

### Responses
#### Success Response (200)
Request completed successfully. The response includes a list of items and pagination information. If `next_page_token` is set, there are more results.
- **examples** (Array of object) - Array of example objects.
  - **create_time** (date-time) - Timestamp when this example was created.
  - **example_id** (string) - The universally unique identifier (UUID) of the example.
  - **guidelines** (Array of string) - Guidelines for answering the question. Optional — examples may be created with just a question; the front-end form does not require guidelines.
  - **name** (string) - Full resource name: knowledge-assistants/{knowledge_assistant_id}/examples/{example_id}
  - **question** (string) - The example question.
  - **update_time** (date-time) - Timestamp when this example was last updated.
- **next_page_token** (string) - Token to retrieve the next page of results.

#### Response Example
{
  "examples": [
    {
      "create_time": "2023-10-27T10:00:00Z",
      "example_id": "example-uuid-1234",
      "guidelines": ["Be concise", "Provide factual answers"],
      "name": "knowledge-assistants/assistant-id-abc/examples/example-uuid-1234",
      "question": "What is the capital of France?",
      "update_time": "2023-10-27T10:05:00Z"
    }
  ],
  "next_page_token": "next-page-token-xyz"
}
```

--------------------------------

### Create an example for a Knowledge Assistant

Source: https://docs.databricks.com/api/workspace/knowledgeassistants/createexample

Creates an example for a Knowledge Assistant, including a question and optional guidelines for responses.

```APIDOC
## Create an example for a Knowledge Assistant

`POST /api/2.1/{parent=knowledge-assistants/*}/examples`

### Description
Creates an example for a Knowledge Assistant.
API scopes:`knowledge-assistants`

### Method
POST

### Endpoint
`/api/2.1/{parent=knowledge-assistants/*}/examples`

### Parameters
#### Path Parameters
- **parent** (string) - Required - Parent resource where this example will be created. Format: knowledge-assistants/{knowledge_assistant_id}

#### Request Body
An example associated with a Knowledge Assistant. Contains a question and guidelines for how the assistant should respond.
- **guidelines** (Array of string) - Optional - Guidelines for answering the question. Optional — examples may be created with just a question; the front-end form does not require guidelines.
- **question** (string) - Required - The example question.

### Response
#### Success Response (200)
Request completed successfully.
- **create_time** (date-time) - Timestamp when this example was created.
- **example_id** (string) - The universally unique identifier (UUID) of the example.
- **guidelines** (Array of string) - Guidelines for answering the question. Optional — examples may be created with just a question; the front-end form does not require guidelines.
- **name** (string) - IDImmutable - Full resource name: knowledge-assistants/{knowledge_assistant_id}/examples/{example_id}
- **question** (string) - The example question.
- **update_time** (date-time) - Timestamp when this example was last updated.
```

--------------------------------

### Get all statuses

Source: https://docs.databricks.com/api/workspace/libraries/allclusterstatuses

Retrieves the installation status of all libraries across all clusters. This includes libraries installed via the API or the libraries UI.

```APIDOC
## GET /api/2.0/libraries/all-cluster-statuses

### Description
Get the status of all libraries on all clusters. A status is returned for all libraries installed on this cluster via the API or the libraries UI.

### Method
GET

### Endpoint
/api/2.0/libraries/all-cluster-statuses

### Parameters
#### Query Parameters
This endpoint does not accept query parameters.

#### Request Body
This endpoint does not accept a request body.

### Responses
#### Success Response (200)
- **statuses** (Array of object) - A list of cluster statuses. Each object contains:
  - **cluster_id** (string) - Unique identifier for the cluster.
  - **library_statuses** (Array of object) - Status of all libraries on the cluster. Each object contains:
    - **is_library_for_all_clusters** (boolean) - Indicates if the library is for all clusters.
    - **library** (object) - Details about the library (e.g., pypi, jar, whl).
    - **status** (string) - The installation status of the library (e.g., INSTALLED, PENDING).

#### Response Example (200)
{
  "statuses": [
    {
      "cluster_id": "1234-56789-abcde",
      "library_statuses": [
        {
          "is_library_for_all_clusters": false,
          "library": {
            "pypi": {
              "package": "numpy",
              "repo": "http://my-pypi-repo.com"
            }
          },
          "status": "INSTALLED"
        },
        {
          "is_library_for_all_clusters": false,
          "library": {
            "jar": "/Workspace/path/to/library.jar"
          },
          "status": "INSTALLED"
        }
      ]
    },
    {
      "cluster_id": "234-567890-fghij",
      "library_statuses": [
        {
          "is_library_for_all_clusters": false,
          "library": {
            "whl": "/Workspace/path/to/library.whl"
          },
          "status": "PENDING"
        }
      ]
    }
  ]
}

### Error Handling
This method might return the following HTTP codes: 400, 401, 403, 404, 429, 500.

Error responses are returned in the following format:
{
  "error_code": "Error code",
  "message": "Human-readable error message."
}

Possible error codes:
HTTP code | error_code | Description
---|---|---
400 | INVALID_PARAMETER_VALUE | Supplied value for a parameter was invalid.
401 | UNAUTHORIZED | The request does not have valid authentication credentials for the operation.
403 | PERMISSION_DENIED | Caller does not have permission to execute the specified operation.
404 | FEATURE_DISABLED | If a given user/entity is trying to use a feature which has been disabled.
429 | REQUEST_LIMIT_EXCEEDED | Request is rejected due to throttling.
500 | INTERNAL_SERVER_ERROR | Internal error.
```

--------------------------------

### Create an Example for a Knowledge Assistant

Source: https://docs.databricks.com/api/workspace/knowledgeassistants/getknowledgeassistant

Creates a new example for a Knowledge Assistant.

```APIDOC
## POST /api/2.0/knowledge-assistants/{assistant_id}/examples

### Description
Creates a new example for a Knowledge Assistant.

### Method
POST

### Endpoint
/api/2.0/knowledge-assistants/{assistant_id}/examples

### Parameters
#### Path Parameters
- **assistant_id** (string) - Required - The ID of the Knowledge Assistant.

#### Request Body
- **content** (string) - Required - The content of the example.
```

--------------------------------

### Get Assignable Roles for Tag Policy Resource

Source: https://docs.databricks.com/api/workspace/accountaccesscontrolproxy/getassignablerolesforresource

This example demonstrates how to get assignable roles for a tag policy. The `access-management` API scope is necessary for this operation.

```bash
curl -v \
     -X GET \
     -H "Authorization: Bearer <ACCESS_TOKEN>" \
     "https://<DATABRICKS_HOST>/api/2.0/preview/accounts/access-control/assignable-roles?resource=accounts/<ACCOUNT_ID>/tagPolicies/<TAG_POLICY_ID>"
```

--------------------------------

### Get Cluster Library Status

Source: https://docs.databricks.com/api/workspace/libraries/clusterstatus

Retrieves the status of all libraries installed on a specific cluster. The response includes details about each library's installation status, messages, and whether it was set for all clusters.

```APIDOC
## GET /api/2.0/libraries/cluster-status

### Description
Get the status of libraries on a cluster. A status is returned for all libraries installed on this cluster via the API or the libraries UI. The order of returned libraries is as follows:
  1. Libraries set to be installed on this cluster, in the order that the libraries were added to the cluster, are returned first.
  2. Libraries that were previously requested to be installed on this cluster or, but are now marked for removal, in no particular order, are returned last.

API scopes:`libraries`

### Query Parameters
- **cluster_id** (string) - Required - Unique identifier of the cluster whose status should be retrieved.

### Responses
#### Success Response (200)
Request completed successfully.
- **cluster_id** (string) - Unique identifier for the cluster.
- **library_statuses** (Array of object) - Status of all libraries on the cluster.
  - **is_library_for_all_clusters** (boolean) - Whether the library was set to be installed on all clusters via the libraries UI.
  - **library** (object) - Unique identifier for the library.
  - **messages** (Array of string) - All the info and warning messages that have occurred so far for this library.
  - **status** (string) - Enum: `PENDING | RESOLVING | INSTALLING | INSTALLED | FAILED | UNINSTALL_ON_RESTART | SKIPPED | RESTORED` - Status of installing the library on the cluster.

#### Error Responses
- **400**: Bad Request
- **401**: Unauthorized
- **403**: Forbidden
- **404**: Not Found
- **429**: Too Many Requests
- **500**: Internal Server Error

Error responses are returned in the following format:
{
  "error_code": "Error code",
  "message": "Human-readable error message."
}
```

--------------------------------

### Example Response for Get Cluster Policy Permissions

Source: https://docs.databricks.com/api/workspace/clusterpolicies/getpermissions

An example of a successful response (200 OK) when retrieving cluster policy permissions, showing the access control list and object details.

```json
{
  "access_control_list": [
    {
      "all_permissions": [
        {
          "inherited": true,
          "inherited_from_object": [
            "string"
          ],
          "permission_level": "CAN_USE"
        }
      ],
      "display_name": "string",
      "group_name": "string",
      "service_principal_name": "string",
      "user_name": "string"
    }
  ],
  "object_id": "string",
  "object_type": "string"
}
```

--------------------------------

### Install from a listing

Source: https://docs.databricks.com/api/workspace/consumerinstallations/create

Use this API to install a Databricks Marketplace listing. You must provide the listing ID and details about the accepted consumer terms, including the catalog name and recipient type. For Git repo installations, specify the repo name and path.

```python
import requests

DATABRICKS_HOST = "https://your-databricks-workspace.cloud.databricks.com/"
DATABRICKS_TOKEN = "dapi..."

listing_id = "your_listing_id"

headers = {
    "Authorization": f"Bearer {DATABRICKS_TOKEN}",
    "Content-Type": "application/json"
}

# Example for Delta Sharing recipient
payload_delta = {
    "accepted_consumer_terms": {
        "version": "1.0",
        "catalog_name": "main",
        "recipient_type": "DELTA_SHARING_RECIPIENT_TYPE_DATABRICKS"
    }
}

# Example for Git repo installation
payload_git = {
    "accepted_consumer_terms": {
        "version": "1.0",
        "catalog_name": "main",
        "recipient_type": "DELTA_SHARING_RECIPIENT_TYPE_DATABRICKS"
    },
    "repo_detail": {
        "repo_name": "my-git-repo",
        "repo_path": "Users/user@example.com/my-repo/README.md"
    }
}

response = requests.post(f"{DATABRICKS_HOST}/api/2.1/marketplace-consumer/listings/{listing_id}/installations", headers=headers, json=payload_delta)

if response.status_code == 200:
    print("Installation successful:", response.json())
else:
    print("Installation failed:", response.status_code, response.text)
```

--------------------------------

### Get listing content metadata

Source: https://docs.databricks.com/api/workspace/consumerfulfillments/get

Retrieves a high-level preview of the metadata for installable content of a listing.

```APIDOC
## Get listing content metadata
Public preview
`
GET
/api/2.1/marketplace-consumer/listings/{listing_id}/content`
Get a high level preview of the metadata of listing installable content.
API scopes:`marketplace`
### Path parameters
`listing_id`requiredstring
### Query parameters
`page_token`string
`page_size`int32
### Responses
**200** Request completed successfully. The response includes a list of items and pagination information. If `next_page_token` is set, there are more results.
Request completed successfully.
The response includes a list of items and pagination information. If `next_page_token` is set, there are more results.
`next_page_token`string
`shared_data_objects`Array of object
Array [
`data_object_type`string
The type of the data object. Could be one of: TABLE, SCHEMA, NOTEBOOK_FILE, MODEL, VOLUME
`name`string
Name of the shared object
]
# Response samples
200
{
"next_page_token": "string",
"shared_data_objects": [
{
"data_object_type": "string",
"name": "string"
}
]
}

```

--------------------------------

### Create Example Knowledge Assistant

Source: https://docs.databricks.com/api/workspace/knowledgeassistants/createexample

This endpoint allows for the creation of example knowledge assistants. It accepts a JSON payload containing guidelines and a question, and returns details of the created assistant.

```APIDOC
## POST /api/2.0/knowledge-assistants/examples

### Description
Creates an example knowledge assistant with the provided guidelines and question.

### Method
POST

### Endpoint
/api/2.0/knowledge-assistants/examples

### Request Body
- **guidelines** (array of strings) - Required - A list of guidelines for the assistant.
- **question** (string) - Required - The question the assistant should address.

### Request Example
{
  "guidelines": [
    "string"
  ],
  "question": "string"
}

### Response
#### Success Response (200)
- **create_time** (string) - The timestamp when the assistant was created.
- **example_id** (string) - The unique identifier for the example assistant.
- **guidelines** (array of strings) - The guidelines associated with the assistant.
- **name** (string) - The name of the assistant.
- **question** (string) - The question the assistant addresses.
- **update_time** (string) - The timestamp when the assistant was last updated.

#### Response Example
{
  "create_time": "2019-08-24T14:15:22Z",
  "example_id": "string",
  "guidelines": [
    "string"
  ],
  "name": "string",
  "question": "string",
  "update_time": "2019-08-24T14:15:22Z"
}
```

--------------------------------

### Databricks Library Installation JSON Example

Source: https://docs.databricks.com/api/workspace/libraries/uninstall

This JSON structure defines various types of libraries that can be installed on a Databricks cluster, including PyPI packages, JARs, Wheels, Maven artifacts, CRAN packages, and requirements files.

```json
{
  "cluster_id": "1234-56789-abcde",
  "libraries": [
    {
      "pypi": {
        "package": "numpy",
        "repo": "http://my-pypi-repo.com"
      }
    },
    {
      "jar": "/Workspace/path/to/library.jar"
    },
    {
      "whl": "/Workspace/path/to/library.whl"
    },
    {
      "maven": {
        "coordinates": "com.databricks:spark-csv_2.11:1.5.0",
        "exclusions": [
          "org.slf4j:slf4j-log4j12"
        ],
        "repo": "http://my-maven-repo.com"
      }
    },
    {
      "cran": {
        "package": "ggplot2",
        "repo": "http://cran.us.r-project.org"
      }
    },
    {
      "requirements": "/Workspace/path/to/requirements.txt"
    }
  ]
}
```

--------------------------------

### List examples for a Supervisor Agent

Source: https://docs.databricks.com/api/workspace/supervisoragents/listexamples

Lists examples under a Supervisor Agent. This API is in Beta and requires the `supervisor-agents` API scope.

```APIDOC
## GET /api/2.1/{parent=supervisor-agents/*}/examples

### Description
Lists examples under a Supervisor Agent.

### Method
GET

### Endpoint
/api/2.1/{parent=supervisor-agents/*}/examples

### Parameters
#### Path Parameters
- **parent** (string) - Required - Parent resource to list from. Format: supervisor-agents/{supervisor_agent_id}

#### Query Parameters
- **page_size** (integer) - Optional - The maximum number of examples to return. If unspecified, at most 100 examples will be returned. The maximum value is 100; values above 100 will be coerced to 100.
- **page_token** (string) - Optional - A page token, received from a previous `ListExamples` call. Provide this to retrieve the subsequent page. If unspecified, the first page will be returned.

### Responses
#### Success Response (200)
- **examples** (Array of object) - Array of example objects, each containing `example_id`, `guidelines`, `name`, and `question`. If `next_page_token` is set, there are more results.
- **next_page_token** (string) - Token for the next page of results.

#### Response Example
```json
{
  "examples": [
    {
      "example_id": "string",
      "guidelines": [
        "string"
      ],
      "name": "string",
      "question": "string"
    }
  ],
  "next_page_token": "string"
}
```
```

--------------------------------

### List all installations

Source: https://docs.databricks.com/api/workspace/consumerinstallations

Retrieves a list of all consumer installations available.

```APIDOC
## List all installations

### Description
Retrieves a list of all consumer installations.

### Method
GET

### Endpoint
/api/marketplace/v1/consumer/installations
```

--------------------------------

### Update Installation Request Body Example

Source: https://docs.databricks.com/api/workspace/consumerinstallations/update

This JSON object represents the request body for updating an installation. It includes fields like `catalog_name`, `share_name`, `status`, and `rotate_token`. The `rotate_token` flag can be set to true to rotate the associated token.

```json
{
  "installation": {
    "catalog_name": "string",
    "error_message": "string",
    "id": "string",
    "installed_on": 0,
    "listing_id": "string",
    "listing_name": "string",
    "recipient_type": "DELTA_SHARING_RECIPIENT_TYPE_DATABRICKS | DELTA_SHARING_RECIPIENT_TYPE_OPEN",
    "repo_name": "string",
    "repo_path": "string",
    "share_name": "string",
    "status": "INSTALLED | FAILED",
    "token_detail": {
      "tokens": [
        {
          "token": "string"
        }
      ]
    },
    "rotate_token": true
  }
}
```

--------------------------------

### Get Exchange Response Sample

Source: https://docs.databricks.com/api/workspace/providerexchanges/get

Example JSON response for a successful retrieval of an exchange, including its metadata, filters, and linked listings.

```json
{
"exchange": {
"comment": "string",
"created_at": 0,
"created_by": "string",
"filters": [
{
"created_at": 0,
"created_by": "string",
"exchange_id": "string",
"filter_type": "GLOBAL_METASTORE_ID",
"filter_value": "string",
"id": "string",
"name": "string",
"updated_at": 0,
"updated_by": "string"
}
],
"id": "string",
"linked_listings": [
{
"created_at": 0,
"created_by": "string",
"exchange_id": "string",
"exchange_name": "string",
"id": "string",
"listing_id": "string",
"listing_name": "string"
}
],
"name": "string",
"updated_at": 0,
"updated_by": "string"
}
}
```

--------------------------------

### Example Response for Default Workspace Base Environment

Source: https://docs.databricks.com/api/workspace/environments/getdefaultworkspacebaseenvironment

An example of a successful response when retrieving the default workspace base environment configuration. It shows the format for CPU and GPU environment identifiers.

```json
{
  "cpu_workspace_base_environment": "string",
  "gpu_workspace_base_environment": "string",
  "name": "string"
}
```

--------------------------------

### Get All Cluster Library Statuses

Source: https://docs.databricks.com/api/workspace/libraries/allclusterstatuses

Retrieve the installation status of all libraries across all clusters. This is useful for monitoring library deployments and ensuring consistency.

```json
{
  "statuses": [
    {
      "cluster_id": "1234-56789-abcde",
      "library_statuses": [
        {
          "is_library_for_all_clusters": false,
          "library": {
            "pypi": {
              "package": "numpy",
              "repo": "http://my-pypi-repo.com"
            }
          },
          "status": "INSTALLED"
        },
        {
          "is_library_for_all_clusters": false,
          "library": {
            "jar": "/Workspace/path/to/library.jar"
          },
          "status": "INSTALLED"
        }
      ]
    },
    {
      "cluster_id": "234-567890-fghij",
      "library_statuses": [
        {
          "is_library_for_all_clusters": false,
          "library": {
            "whl": "/Workspace/path/to/library.whl"
          },
          "status": "PENDING"
        }
      ]
    }
  ]
}
```

--------------------------------

### Create an example for a Supervisor Agent

Source: https://docs.databricks.com/api/workspace/supervisoragents/createexample

Creates an example for a Supervisor Agent. This includes a question and guidelines for how the agent should respond.

```APIDOC
## POST /api/2.1/{parent=supervisor-agents/*}/examples

### Description
Creates an example for a Supervisor Agent.

### Method
POST

### Endpoint
/api/2.1/{parent=supervisor-agents/*}/examples

### Parameters
#### Path Parameters
- **parent** (string) - Required - Parent resource where this example will be created. Format: supervisor-agents/{supervisor_agent_id}

#### Request Body
An example associated with a Supervisor Agent. Contains a question and guidelines for how the agent should respond.
- **guidelines** (Array of string) - Required - Guidelines for answering the question.
- **question** (string) - Required - The example question.

### Request Example
```json
{
  "guidelines": [
    "string"
  ],
  "question": "string"
}
```

### Response
#### Success Response (200)
Request completed successfully.
- **example_id** (string) - The universally unique identifier (UUID) of the example.
- **guidelines** (Array of string) - Guidelines for answering the question.
- **name** (string) - Full resource name: supervisor-agents/{supervisor_agent_id}/examples/{example_id}
- **question** (string) - The example question.

#### Response Example
```json
{
  "example_id": "string",
  "guidelines": [
    "string"
  ],
  "name": "string",
  "question": "string"
}
```
```

--------------------------------

### Get Notification Destination

Source: https://docs.databricks.com/api/workspace/notificationdestinations/get

Retrieves the configuration details of a specific notification destination using its ID. This is useful for auditing or understanding existing notification setups.

```bash
curl -X GET \
     -H "Authorization: Bearer <databricks-api-token>" \
     -H "Content-Type: application/json" \
     "https://<databricks-workspace-url>/api/2.0/notification-destinations/{id}"
```

--------------------------------

### List all installations

Source: https://docs.databricks.com/api/workspace/consumerinstallations/list

Retrieves a list of all consumer installations across all available listings. Supports pagination for large result sets.

```APIDOC
## GET /api/2.1/marketplace-consumer/installations

### Description
List all installations across all listings.

### Method
GET

### Endpoint
/api/2.1/marketplace-consumer/installations

### Query Parameters
- **page_token** (string) - Optional - Token to retrieve the next page of results.
- **page_size** (int32) - Optional - The number of installations to return per page.

### Responses
#### Success Response (200)
- **installations** (Array of object) - A list of installation objects, each containing details about a specific installation.
  - **catalog_name** (string) - The name of the catalog associated with the installation.
  - **error_message** (string) - An error message if the installation failed.
  - **id** (string) - The unique identifier for the installation.
  - **installed_on** (int64) - The timestamp when the installation was completed.
  - **listing_id** (string) - The ID of the listing from which the item was installed.
  - **listing_name** (string) - The name of the listing.
  - **recipient_type** (string) - The type of recipient (e.g., DELTA_SHARING_RECIPIENT_TYPE_DATABRICKS, DELTA_SHARING_RECIPIENT_TYPE_OPEN).
  - **repo_name** (string) - The name of the repository, if applicable.
  - **repo_path** (string) - The path to the repository, if applicable.
  - **share_name** (string) - The name of the share, if applicable.
  - **status** (string) - The current status of the installation (e.g., INSTALLED, FAILED).
  - **token_detail** (object) - Details about the token used for the installation.
    - **bearerToken** (string) - The bearer token.
    - **endpoint** (string) - The endpoint associated with the token.
    - **expirationTime** (string) - The expiration time of the token.
    - **shareCredentialsVersion** (int64) - The version of the share credentials.
  - **tokens** (Array of object) - A list of token details.
    - **activation_url** (string) - The activation URL for the token.
    - **created_at** (int64) - The timestamp when the token was created.
    - **created_by** (string) - The user who created the token.
    - **expiration_time** (int64) - The expiration time of the token.
    - **id** (string) - The unique identifier for the token.
    - **updated_at** (int64) - The timestamp when the token was last updated.
    - **updated_by** (string) - The user who last updated the token.
- **next_page_token** (string) - A token to retrieve the next page of results, if available.

#### Response Example
```json
{
  "installations": [
    {
      "catalog_name": "string",
      "error_message": "string",
      "id": "string",
      "installed_on": 0,
      "listing_id": "string",
      "listing_name": "string",
      "recipient_type": "DELTA_SHARING_RECIPIENT_TYPE_DATABRICKS",
      "repo_name": "string",
      "repo_path": "string",
      "share_name": "string",
      "status": "INSTALLED",
      "token_detail": {
        "bearerToken": "string",
        "endpoint": "string",
        "expirationTime": "string",
        "shareCredentialsVersion": 0
      },
      "tokens": [
        {
          "activation_url": "string",
          "created_at": 0,
          "created_by": "string",
          "expiration_time": 0,
          "id": "string",
          "updated_at": 0,
          "updated_by": "string"
        }
      ]
    }
  ],
  "next_page_token": "string"
}
```
```

--------------------------------

### Get Repo Example - API Response

Source: https://docs.databricks.com/api/workspace/repos/get

A successful response includes information about the repository such as its branch, commit ID, path, provider, and sparse checkout settings.

```json
{
  "branch": "main",
  "head_commit_id": "7e0847ede61f07adede22e2bcce6050216489171",
  "id": 5249608814509279,
  "path": "/Users/user@company.com/testrepo",
  "provider": "gitHub",
  "sparse_checkout": {
    "patterns": []
  },
  "url": "https://github.com/databricks/cli.git"
}
```

--------------------------------

### List Deployments Response Sample

Source: https://docs.databricks.com/api/workspace/apps/listdeployments

This is a sample JSON response when listing application deployments. It includes details such as the command to run, creation time, creator, deployment artifacts, environment variables, Git source information, mode, source code path, and status.

```json
{
  "app_deployments": [
    {
      "command": [
        "python app.py"
      ],
      "create_time": "2019-08-24T14:15:22Z",
      "creator": "user@test.com",
      "deployment_artifacts": {
        "source_code_path": "/Workspace/Users/9627a015-e892-43f7-9085-eec3892da408/src/01ef1a1ed75d1964b62234a35efa61fc"
      },
      "deployment_id": "01ef0bda89f21f08a8351f41e4a9b948",
      "env_vars": [
        {
          "name": "VOLUME_URI",
          "value": "/Volumes/catalog-name/schema-name/dir-name",
          "value_from": "volume"
        }
      ],
      "git_source": {
        "branch": "main",
        "commit": "abc123def456",
        "git_repository": {
          "provider": "gitHub",
          "url": "https://github.com/databricks/git_app_repo.git"
        },
        "resolved_commit": "abc123def456789012345678901234567890abcd",
        "source_code_path": "my-app",
        "tag": "v1.0.0"
      },
      "mode": "SNAPSHOT",
      "source_code_path": "/Workspace/user@test.com/my_custom_app",
      "status": {
        "message": "Deployment is in progress.",
        "state": "SUCCEEDED"
      },
      "update_time": "2019-08-24T14:15:22Z"
    }
  ],
  "next_page_token": "string"
}
```