UI Bakery

https://docs.uibakery.io
Admin
UI Bakery is a low-code platform for building internal software with drag-and-drop UI components,...
Tokens:173,777
Snippets:2,508
Trust Score:9.8
Update:2 months ago
Show doc for...
Tokens:
Raw
### Prepare Installation Directory

Source: https://docs.uibakery.io/on-premise/install-and-update/installing-on-premise-version/manual-w-docker-run.md

Create a dedicated directory and download the setup script to initialize the environment.

```bash
mkdir ui-bakery-on-premise && cd ui-bakery-on-premise && curl -k -L -o setup.sh https://raw.githubusercontent.com/uibakery/self-hosted/main/setup.sh
```

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

### Install Certbot via Snap

Source: https://docs.uibakery.io/on-premise/networking-and-security/setting-up-ssl-on-ubuntu.md

Commands to install and refresh the snap core, followed by the installation of the Certbot tool.

```bash
sudo snap install core; sudo snap refresh core
```

```bash
sudo snap install --classic certbot
```

```bash
sudo ln -s /snap/bin/certbot /usr/bin/certbot
```

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

### Download UI Bakery configuration files

Source: https://docs.uibakery.io/on-premise/install-and-update/installing-on-premise-version/manual-w-docker-compose.md

Downloads the necessary docker-compose files and setup script for the on-premise installation.

```bash
mkdir ui-bakery-on-premise && cd ui-bakery-on-premise && curl -k -L -o docker-compose.yml https://raw.githubusercontent.com/uibakery/self-hosted/main/docker-compose.yml && curl -k -L -o docker-compose-external-db.yml https://raw.githubusercontent.com/uibakery/self-hosted/main/docker-compose-external-db.yml && curl -k -L -o setup.sh https://raw.githubusercontent.com/uibakery/self-hosted/main/setup.sh
```

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

### Backup Installation Folder

Source: https://docs.uibakery.io/on-premise/install-and-update/updating-on-premise-version.md

Create a copy of the current installation directory before performing a major update.

```bash
cp -R ui-bakery-on-premise ui-bakery-on-premise_old
```

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

### Navigate to Installation Directory

Source: https://docs.uibakery.io/on-premise/install-and-update/updating-on-premise-version.md

Change the current working directory to the UI Bakery on-premise installation folder.

```bash
cd ./ui-bakery-on-premise
```

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

### General component usage example

Source: https://docs.uibakery.io/concepts/custom-components-2.0.md

A comprehensive example demonstrating data retrieval, action execution, and event triggering within a single component.

```javascript
import { useData, useLoadAction, useMutateAction, triggerEvent } from '@uibakery/data';

function MyComponent() {
  // Receiving data from UI Bakery
  const componentData = useData('someData', {});

  // Loading data via an action
  const [items, loading, error, refreshItems] = useLoadAction('loadItems', []);

  // Action for creating data
  const [createItem] = useMutateAction('createItem');

  const handleCreate = () => {
    const newItem = { name: 'A New Item' };
    // Call the action
    createItem(newItem);
    // Trigger the event
    triggerEvent({ type: 'itemCreated', data: newItem });
  };

  // ... rest of the component code
}
```

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

### Example ngrok authtoken format

Source: https://docs.uibakery.io/concepts/data-sources/connecting-local-database-via-ngrok.md

An example of how the personal authtoken appears.

```text
20JWDkD3uwe2wuRqhCvuTkQ0LE3_5N6KtiEBDLD3fXZkRHpej
```

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

### Deploy Container Instance

Source: https://docs.uibakery.io/on-premise/install-and-update/installing-on-premise-version/azure-container-instance.md

Start the application using Docker Compose.

```bash
docker compose -f docker-compose-azure-container-instances.yml up
```

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

### Install UI Bakery on-premise

Source: https://docs.uibakery.io/concepts/data-sources/connecting-local-database-via-ngrok.md

Command to install the self-hosted version of UI Bakery.

```bash
curl -k -L -o install.sh https://raw.githubusercontent.com/uibakery/self-hosted/main/install.sh && bash ./install.sh
```

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

### Load Table Filtering Examples

Source: https://docs.uibakery.io/reference/working-with-actions/load-table-action.md

Examples of filter conditions and the resulting SQL query.

```javascript
// name like "%Bobbie%"
{{ui.input.value}}
```

```sql
SELECT * FROM users WHERE name LIKE "%Bobbie%" LIMIT 1000;
```

```javascript
// id in array
[1,2,3]
```

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

### Query Documentation via HTTP GET

Source: https://docs.uibakery.io/build-from-scratch/getting-started/build-ui.md

Perform an HTTP GET request to the documentation URL with 'ask' and 'goal' parameters to retrieve information dynamically.

```http
GET https://docs.uibakery.io/build-from-scratch/getting-started/build-ui.md?ask=<question>&goal=<endgoal>
```

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

### Query documentation via HTTP GET

Source: https://docs.uibakery.io/build-from-scratch/getting-started/change-component-data.md

Perform an HTTP GET request to the documentation URL with 'ask' and 'goal' parameters to retrieve information dynamically.

```http
GET https://docs.uibakery.io/build-from-scratch/getting-started/change-component-data.md?ask=<question>&goal=<endgoal>
```

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

### GET /on-premise/install-and-update/installing-on-premise-version/digitalocean-1-click-droplet.md

Source: https://docs.uibakery.io/on-premise/install-and-update/installing-on-premise-version/digitalocean-1-click-droplet.md

Perform an HTTP GET request to query the documentation dynamically for specific information.

```APIDOC
## GET /on-premise/install-and-update/installing-on-premise-version/digitalocean-1-click-droplet.md

### Description
Queries the documentation dynamically by providing a natural language question and an optional end goal to receive a tailored answer with relevant excerpts.

### Method
GET

### Endpoint
https://docs.uibakery.io/on-premise/install-and-update/installing-on-premise-version/digitalocean-1-click-droplet.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

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

### GET /reference/working-with-components/qr-code.md

Source: https://docs.uibakery.io/reference/working-with-components/qr-code.md

Query the documentation for this component dynamically.

```APIDOC
## GET /reference/working-with-components/qr-code.md

### Description
Perform an HTTP GET request on the current page URL to query the documentation dynamically.

### Query Parameters
- **ask** (string) - Required - The specific question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the answer.
```

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

### Initialize Datadog RUM

Source: https://docs.uibakery.io/on-premise/on-premise-features/external-analytics.md

Example initialization script for Datadog Real User Monitoring.

```javascript
import { datadogRum } from '@datadog/browser-rum';

datadogRum.init({
    applicationId: 'xxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
    clientToken: 'pubxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
    site: 'datadoghq.com',
    service:'ui-bakery',
    
    // Specify a version number to identify the deployed version of your application in Datadog 
    // version: '1.0.0',
    sessionSampleRate: 100,
    sessionReplaySampleRate: 20,
    trackUserInteractions: true,
    trackResources: true,
    trackLongTasks: true,
    defaultPrivacyLevel:'mask-user-input'
});
    
datadogRum.startSessionReplayRecording();
```

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

### Importing External Modules

Source: https://docs.uibakery.io/reference/working-with-actions/python-backend-code.md

Examples showing how to import and use NumPy and Pandas libraries.

```python
import numpy as np

# Now you can use NumPy functions and tools in your code, for example:
my_array = np.array([1, 2, 3])
```

```python
import pandas as pd

# Now you can use Pandas functions and tools in your code, for example:
my_dataframe = pd.DataFrame({'col1': [1, 2], 'col2': [3, 4]})
```

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

### GET /reference/working-with-components/menu.md

Source: https://docs.uibakery.io/reference/working-with-components/menu.md

Query the documentation dynamically for additional information.

```APIDOC
## GET /reference/working-with-components/menu.md

### Description
Performs a query against the documentation to retrieve answers or context not explicitly found on the page.

### Method
GET

### Endpoint
https://docs.uibakery.io/reference/working-with-components/menu.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

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

### GET /reference/working-with-components/embedded-app.md

Source: https://docs.uibakery.io/reference/working-with-components/embedded-app.md

Query the documentation dynamically by asking a question.

```APIDOC
## GET /reference/working-with-components/embedded-app.md

### Description
Query the documentation dynamically by asking a question.

### Method
GET

### Endpoint
https://docs.uibakery.io/reference/working-with-components/embedded-app.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific question to ask.
- **goal** (string) - Optional - The broader end goal to accomplish.
```

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

### GET /reference/working-with-components/video.md

Source: https://docs.uibakery.io/reference/working-with-components/video.md

Query the documentation for the Video component dynamically.

```APIDOC
## GET /reference/working-with-components/video.md

### Description
Perform a query against the documentation to retrieve information not explicitly covered in the static page.

### Method
GET

### Endpoint
https://docs.uibakery.io/reference/working-with-components/video.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

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

### GET /reference/working-with-components/currency.md

Source: https://docs.uibakery.io/reference/working-with-components/currency.md

Query the documentation dynamically by asking a question related to the content.

```APIDOC
## GET /reference/working-with-components/currency.md

### Description
Perform an HTTP GET request on the current page URL to query the documentation dynamically.

### Method
GET

### Endpoint
https://docs.uibakery.io/reference/working-with-components/currency.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - Describes the broader end goal to tailor the answer.
```

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

### GET /reference/working-with-components/steps.md

Source: https://docs.uibakery.io/reference/working-with-components/steps.md

Queries the documentation for additional information or clarification regarding the Steps component.

```APIDOC
## GET /reference/working-with-components/steps.md

### Description
Perform an HTTP GET request on the current page URL to query the documentation dynamically using natural language.

### Method
GET

### Endpoint
https://docs.uibakery.io/reference/working-with-components/steps.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the answer.
```

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

### Get list of workspace roles response

Source: https://docs.uibakery.io/on-premise/on-premise-features/scim-2.0.md

Example JSON response for a successful GET request to retrieve all workspace roles.

```json
{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "totalResults": 3,
  "Resources": [
    {
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:Group"
      ],
      "id": "bdeM5DxR8tG",
      "meta": {
        "created": "2023-06-15T12:49:42+03:00",
        "resourceType": "Group",
        "location": "/scim/v2/workspace/Groups/ddMfWdR8tG"
      },
      "displayName": "admin",
      "members": [
        {
          "value": "user@example.com",
          "display": "John Doe"
        }
      ],
      "roleType": "workspace"
    },
    ...
  ]
}
```

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

### Get role details by ID response

Source: https://docs.uibakery.io/on-premise/on-premise-features/scim-2.0.md

Example JSON response for a successful GET request to retrieve details of a specific role.

```json
{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:Group"
  ],
  "id": "bdeM5DxR8tG",
  "externalId": null,
  "meta": {
    "resourceType": null,
    "created": "2023-06-15T09:49:42.000+00:00",
  },
  "displayName": "admin",
  "members": [
    {
      "value": "user@example.com",
      "display": "John Doe",
    }
  ],
  "roleType": "workspace"
}
```

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

### Execute Setup Script

Source: https://docs.uibakery.io/on-premise/install-and-update/installing-on-premise-version/manual-w-docker-run.md

Run the downloaded script to generate the necessary .env configuration file.

```bash
./setup.sh
```

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

### Create and navigate to installation directory

Source: https://docs.uibakery.io/on-premise/install-and-update/installing-on-premise-version/windows-installation.md

Commands to create a dedicated folder for configuration files and switch to it.

```bash
mkdir ui-bakery-on-premise
```

```bash
cd ui-bakery-on-premise
```

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

### GET /build-from-scratch/getting-started/deploy-your-application-and-invite-users.md

Source: https://docs.uibakery.io/build-from-scratch/getting-started/deploy-your-application-and-invite-users.md

Queries the documentation for specific information by providing a question and an optional goal.

```APIDOC
## GET /build-from-scratch/getting-started/deploy-your-application-and-invite-users.md

### Description
Queries the documentation dynamically to retrieve answers, excerpts, and sources based on a specific question.

### Method
GET

### Endpoint
https://docs.uibakery.io/build-from-scratch/getting-started/deploy-your-application-and-invite-users.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.

### Response
- The response contains a direct answer to the question along with relevant excerpts and sources from the documentation.
```

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

### GET /concepts/source-control/getting-started.md

Source: https://docs.uibakery.io/concepts/source-control/getting-started.md

Perform a query against the documentation to retrieve answers and relevant excerpts based on a specific question and optional goal.

```APIDOC
## GET /concepts/source-control/getting-started.md

### Description
Queries the documentation dynamically to retrieve an answer and relevant excerpts based on a natural language question.

### Method
GET

### Endpoint
https://docs.uibakery.io/concepts/source-control/getting-started.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the answer.

### Response
#### Success Response (200)
- **response** (string) - A direct answer to the question along with relevant excerpts and sources from the documentation.
```

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

### Enable UI Inspirations

Source: https://docs.uibakery.io/on-premise/additional-configurations/self-hosted-ai-chat-setup.md

Set the API key to allow the agent to fetch component examples from 21st.dev.

```bash
UI_BAKERY_FETCH_UI_API_KEY=<21st-dev-fetch-ui-api-key>
```

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

### GET /reference/working-with-components/color-picker.md

Source: https://docs.uibakery.io/reference/working-with-components/color-picker.md

Query the documentation for the Color Picker component using natural language.

```APIDOC
## GET /reference/working-with-components/color-picker.md

### Description
Perform a query against the documentation to retrieve specific information or clarification regarding the Color Picker component.

### Method
GET

### Endpoint
https://docs.uibakery.io/reference/working-with-components/color-picker.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific question to ask about the component.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

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

### GET /reference/working-with-components/link.md

Source: https://docs.uibakery.io/reference/working-with-components/link.md

Query the documentation dynamically using an HTTP GET request.

```APIDOC
## GET /reference/working-with-components/link.md

### Description
Perform an HTTP GET request on the current page URL to query the documentation dynamically.

### Method
GET

### Endpoint
https://docs.uibakery.io/reference/working-with-components/link.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to tailor the answer.
```

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

### Example Agent Task: Manage Git Integration

Source: https://docs.uibakery.io/mcp-server.md

A sample prompt for requesting Git repository creation and connection.

```text
Create a new GitHub repository named "ui-bakery-a" in my account and connect the "A" app to it. Show me the proposed repository and branch settings before applying them.
```

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

### GET /reference/working-with-components/file.md

Source: https://docs.uibakery.io/reference/working-with-components/file.md

Queries the documentation dynamically by asking a question related to the current page.

```APIDOC
## GET /reference/working-with-components/file.md

### Description
Perform a query against the documentation to retrieve answers or context related to the File component.

### Method
GET

### Endpoint
https://docs.uibakery.io/reference/working-with-components/file.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

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

### GET /build-from-scratch/video-intro.md

Source: https://docs.uibakery.io/build-from-scratch/video-intro.md

Queries the documentation page for specific information using natural language questions.

```APIDOC
## GET /build-from-scratch/video-intro.md

### Description
Queries the documentation page dynamically to retrieve answers, excerpts, or context based on a natural language question.

### Method
GET

### Endpoint
https://docs.uibakery.io/build-from-scratch/video-intro.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.

### Response
#### Success Response (200)
- **answer** (string) - A direct answer to the question.
- **excerpts** (array) - Relevant excerpts and sources from the documentation.
```

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

### Example Agent Task: Manage Workspace Users and Roles

Source: https://docs.uibakery.io/mcp-server.md

A sample prompt for requesting role creation and user assignment.

```text
Create a custom role named "App Viewer" with view-only access to apps "Users", "Products", and "Orders". Assign it to the users listed in the attached "list.xlsx" file.
```

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

### Show Notification Message Example

Source: https://docs.uibakery.io/reference/working-with-actions/show-notification-action.md

A simple example of a notification message using data binding.

```javascript
User {{data.id}} was created successfully
```

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

### GET /reference/working-with-components/table/getting-started-with-the-component.md

Source: https://docs.uibakery.io/reference/working-with-components/table/getting-started-with-the-component.md

Queries the documentation dynamically to retrieve answers, excerpts, and sources based on a specific question and optional end goal.

```APIDOC
## GET /reference/working-with-components/table/getting-started-with-the-component.md

### Description
Perform a dynamic query against the documentation to receive a direct answer and relevant excerpts.

### Method
GET

### Endpoint
https://docs.uibakery.io/reference/working-with-components/table/getting-started-with-the-component.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

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

### Git commit audit log example

Source: https://docs.uibakery.io/on-premise/git-source-control/git-audit-log-events.md

Example of the JSON structure for a Git commit event.

```json
{
  "gitUrl": "https://github.com/company/internal-tools.git",
  "branch": "main",
  "commitHash": "abc123",
  "commitMessage": "Update dashboard filters"
}
```

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

### Setting up JSON-server for mock APIs

Source: https://docs.uibakery.io/build-from-scratch/getting-started/build-ui/mocking-data.md

Commands and configuration for using the JSON-server npm package to create a mock REST API.

```bash
npm install -g json-server
```

```json
{
  "posts": [
    { "id": 1, "title": "json-server", "author": "typicode" }
  ],
  "comments": [
    { "id": 1, "body": "some comment", "postId": 1 }
  ],
  "profile": { "name": "typicode" }
}
```

```bash
json-server --watch db.json
```

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

### Create database and user

Source: https://docs.uibakery.io/on-premise/install-and-update/recommendations/running-a-standalone-database-instance.md

SQL script to initialize the database and grant necessary permissions to the application user.

```sql
CREATE DATABASE bakery;

CREATE USER 'bakery'@'host' IDENTIFIED BY 'password';

GRANT
  SELECT, INSERT, UPDATE, DELETE, CREATE, DROP,
  REFERENCES, INDEX, ALTER, LOCK TABLES, EXECUTE,
  CREATE ROUTINE, ALTER ROUTINE 
ON bakery.* TO 'bakery'@'host';
```

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

### Git connect audit log example

Source: https://docs.uibakery.io/on-premise/git-source-control/git-audit-log-events.md

Example of the JSON structure for a Git connect event.

```json
{
  "gitUrl": "https://github.com/company/internal-tools.git",
  "defaultBranch": "main"
}
```

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

### Rendered email template example

Source: https://docs.uibakery.io/build-with-ai/usage-credits-monitoring.md

An example of how the template variables are replaced in the final email output.

```html
<h2>Low credits for Acme</h2>
<p>Hello Jane Admin, acme has 9.5 usage credits left from 250.0. Remaining: 3.8%.</p>
```

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

### GET /on-premise/install-and-update.md

Source: https://docs.uibakery.io/on-premise/install-and-update.md

Queries the documentation dynamically by providing a question and an optional goal to receive a direct answer with relevant excerpts.

```APIDOC
## GET /on-premise/install-and-update.md

### Description
Perform an HTTP GET request on the documentation page URL to query information dynamically. This is useful when specific details are not explicitly present in the current page.

### Method
GET

### Endpoint
https://docs.uibakery.io/on-premise/install-and-update.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

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

### GET /reference/data-sources/aws-athena.md

Source: https://docs.uibakery.io/reference/data-sources/aws-athena.md

Query the documentation dynamically by performing an HTTP GET request on the page URL.

```APIDOC
## GET /reference/data-sources/aws-athena.md

### Description
Perform an HTTP GET request on the current page URL to query the documentation dynamically when information is not explicitly present or additional context is needed.

### Method
GET

### Endpoint
https://docs.uibakery.io/reference/data-sources/aws-athena.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the answer.
```

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

### GET /build-from-scratch/getting-started/build-ui/mocking-data.md

Source: https://docs.uibakery.io/build-from-scratch/getting-started/build-ui/mocking-data.md

Performs a query against the documentation page to retrieve answers and relevant excerpts based on a specific question and optional goal.

```APIDOC
## GET /build-from-scratch/getting-started/build-ui/mocking-data.md

### Description
Queries the documentation page dynamically to retrieve information not explicitly present in the current content.

### Method
GET

### Endpoint
https://docs.uibakery.io/build-from-scratch/getting-started/build-ui/mocking-data.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

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

### GET /on-premise/install-and-update/recommendations.md

Source: https://docs.uibakery.io/on-premise/install-and-update/recommendations.md

Queries the documentation for specific information by providing a question and an optional goal.

```APIDOC
## GET /on-premise/install-and-update/recommendations.md

### Description
Queries the documentation dynamically to retrieve answers and relevant excerpts based on a specific question.

### Method
GET

### Endpoint
https://docs.uibakery.io/on-premise/install-and-update/recommendations.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the answer.
```

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

### Install Ingress NGINX via Helm

Source: https://docs.uibakery.io/on-premise/networking-and-security/custom-base-url.md

Command to install the ingress-nginx controller into the specified Kubernetes namespace.

```bash
helm upgrade --install ingress-nginx ingress-nginx --repo https://kubernetes.github.io/ingress-nginx --namespace ui-bakery
```

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

### Install NGINX

Source: https://docs.uibakery.io/on-premise/networking-and-security/custom-base-url.md

Commands to update package lists and install the NGINX web server on Debian-based systems.

```bash
sudo apt update
sudo apt install nginx
```

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

### GET /on-premise/install-and-update/installing-on-premise-version/manual-w-docker-run.md

Source: https://docs.uibakery.io/on-premise/install-and-update/installing-on-premise-version/manual-w-docker-run.md

Performs a query against the documentation to retrieve answers, excerpts, and sources based on a natural language question.

```APIDOC
## GET /on-premise/install-and-update/installing-on-premise-version/manual-w-docker-run.md

### Description
Performs a query against the documentation to retrieve answers, excerpts, and sources based on a natural language question.

### Method
GET

### Endpoint
https://docs.uibakery.io/on-premise/install-and-update/installing-on-premise-version/manual-w-docker-run.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained natural language question.
- **goal** (string) - Optional - Describes the broader end goal to tailor the answer.
```

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

### GET /how-tos/components-recipes/building-wizard-ui-with-stepper.md

Source: https://docs.uibakery.io/how-tos/components-recipes/building-wizard-ui-with-stepper.md

Queries the documentation page for specific information using a natural language question and an optional goal.

```APIDOC
## GET /how-tos/components-recipes/building-wizard-ui-with-stepper.md

### Description
Queries the documentation page dynamically to retrieve answers, excerpts, and sources based on a provided question.

### Method
GET

### Endpoint
https://docs.uibakery.io/how-tos/components-recipes/building-wizard-ui-with-stepper.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained natural language question.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

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

### GET /reference/working-with-actions/bulk-delete-rows-action.md

Source: https://docs.uibakery.io/reference/working-with-actions/bulk-delete-rows-action.md

Perform an HTTP GET request on the documentation page URL to query information dynamically.

```APIDOC
## GET /reference/working-with-actions/bulk-delete-rows-action.md

### Description
Query the documentation dynamically by asking a question related to the content.

### Method
GET

### Endpoint
https://docs.uibakery.io/reference/working-with-actions/bulk-delete-rows-action.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question in natural language.
- **goal** (string) - Optional - The broader end goal to help tailor the answer.
```

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

### Example Agent Task: Build and Update Apps

Source: https://docs.uibakery.io/mcp-server.md

A sample prompt for requesting app modifications from an AI agent.

```text
Add a users table to the "Products Dashboard" app and populate it with data from the "My DB" data source.
```

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

### SQL DELETE Statement Example

Source: https://docs.uibakery.io/reference/working-with-actions/bulk-delete-rows-action.md

Example of the SQL statement generated by the Bulk Delete Rows action based on specified conditions.

```sql
DELETE FROM users WHERE id IN (23, 24, 25);
```

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

### Git SSH key generation audit log example

Source: https://docs.uibakery.io/on-premise/git-source-control/git-audit-log-events.md

Example of the JSON structure for a Git SSH key generation event.

```json
{
  "gitUrl": "https://github.com/company/internal-tools.git",
  "replacedExistingKey": true
}
```

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

### Start internal PostgreSQL database container

Source: https://docs.uibakery.io/on-premise/install-and-update/installing-on-premise-version/manual-w-docker-run.md

Launch the built-in PostgreSQL database container.

```bash
docker run -d \
  --name bakery-db \
  --restart always \
  --health-cmd "pg_isready -U bakery" \
  --health-interval 1s \
  --health-timeout 5s \
  --health-retries 10 \
  --env-file .env \
  -e POSTGRES_USER="bakery" \
  -e POSTGRES_PASSWORD="bakery" \
  -e POSTGRES_DB="bakery" \
  -v internal-db:/var/lib/postgresql/data \
  --network ui-bakery-on-premise \
  postgres:16.1
```

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

### MUI React Template Setup

Source: https://docs.uibakery.io/concepts/components/custom-component.md

Includes necessary CDN scripts for React, Babel, and MUI, along with a basic sign-in form implementation.

```html
<!-- React -->
<script src="https://unpkg.com/react@latest/umd/react.development.js" crossorigin="anonymous"></script>
<script src="https://unpkg.com/react-dom@latest/umd/react-dom.development.js"></script>
<script src="https://unpkg.com/babel-standalone@latest/babel.min.js" crossorigin="anonymous"></script>

<!-- MUI -->
<script src="https://unpkg.com/@mui/material@latest/umd/material-ui.development.js" crossorigin="anonymous"></script>
<!-- Fonts to support Material Design -->
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,500,700&display=swap"/>
<!-- Icons to support Material Design -->
<link rel="stylesheet" href="https://fonts.googleapis.com/icon?family=Material+Icons"/>

<div id="root"></div>

<script type="text/babel">
    const {
        Avatar,
        Button,
        CssBaseline,
        TextField,
        FormControlLabel,
        Checkbox,
        Link,
        Grid,
        Box,
        Typography,
        Container,
        createTheme,
        ThemeProvider
    } = MaterialUI;

    const theme = createTheme();

    function Copyright(props) {
        return (
            <Typography variant="body2" color="text.secondary" align="center" {...props}>
                {'Copyright © '}
                <Link color="inherit" href="https://mui.com/">
                    Your Website
                </Link>{' '}
                {new Date().getFullYear()}
                {'.'}
            </Typography>
        );
    }

    function App() {
        const handleSubmit = (event) => {
            event.preventDefault();
            const data = new FormData(event.currentTarget);
            console.log({
                email: data.get('email'),
                password: data.get('password'),
            });
        };

        return (
            <ThemeProvider theme={theme}>
                <Container component="main" maxWidth="xs">
                    <CssBaseline />
                    <Box
                        sx={{
                            marginTop: 8,
                            display: 'flex',
                            flexDirection: 'column',
                            alignItems: 'center',
                        }}
                    >
                        <Avatar sx={{ m: 1, bgcolor: 'secondary.main' }}/>
                        <Typography component="h1" variant="h5">
                            Sign in
                        </Typography>
                        <Box component="form" onSubmit={handleSubmit} noValidate sx={{ mt: 1 }}>
                            <TextField
                                margin="normal"
                                required
                                fullWidth
                                id="email"
                                label="Email Address"
                                name="email"
                                autoComplete="email"
                                autoFocus
                            />
                            <TextField
                                margin="normal"
                                required
                                fullWidth
                                name="password"
                                label="Password"
                                type="password"
                                id="password"
                                autoComplete="current-password"
                            />
                            <FormControlLabel
                                control={<Checkbox value="remember" color="primary" />}
                                label="Remember me"
                            />
                            <Button
                                type="submit"
                                fullWidth
                                variant="contained"
                                sx={{ mt: 3, mb: 2 }}
                            >
                                Sign In
                            </Button>
                            <Grid container>
                                <Grid item xs>
                                    <Link href="#" variant="body2">
                                        Forgot password?
                                    </Link>
                                </Grid>
                                <Grid item>
                                    <Link href="#" variant="body2">
                                        {"Don't have an account? Sign Up"}
                                    </Link>
                                </Grid>
                            </Grid>
                        </Box>
                    </Box>
                    <Copyright sx={{ mt: 8, mb: 4 }} />
                </Container>
            </ThemeProvider>
        );
    }

    const root = ReactDOM.createRoot(document.getElementById("root"));
    root.render(<App/>);

</script>
```

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

### Querying Documentation via HTTP GET

Source: https://docs.uibakery.io/concepts/actions/additional-action-settings.md

Perform an HTTP GET request to the documentation URL to retrieve answers to specific questions.

```http
GET https://docs.uibakery.io/concepts/actions/additional-action-settings.md?ask=<question>&goal=<endgoal>
```

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

### Generate and import custom keystore

Source: https://docs.uibakery.io/on-premise/networking-and-security/configuring-custom-certificate-authority.md

Create a Java keystore and import the custom certificate for SSO/OAuth services.

```bash
keytool -genkey -keyalg RSA -keystore mybakerystore.jks
```

```bash
keytool -import -trustcacerts -keystore mybakerystore.jks -alias mycert -file file.cer
```

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

### GET /build-from-scratch/custom-app.md

Source: https://docs.uibakery.io/build-from-scratch/custom-app.md

Performs a dynamic query against the documentation page to retrieve answers and relevant excerpts.

```APIDOC
## GET /build-from-scratch/custom-app.md

### Description
Performs an HTTP GET request on the current page URL to query the documentation dynamically for specific information.

### Method
GET

### Endpoint
https://docs.uibakery.io/build-from-scratch/custom-app.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - Describes the broader end goal to help tailor the response.
```

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

### Query documentation via HTTP

Source: https://docs.uibakery.io/build-from-scratch/getting-started/transform-data-with-javascript.md

Perform a GET request to the documentation URL with 'ask' and 'goal' parameters to retrieve information dynamically.

```http
GET https://docs.uibakery.io/build-from-scratch/getting-started/transform-data-with-javascript.md?ask=<question>&goal=<endgoal>
```

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

### GET /reference/working-with-components/date-and-time.md

Source: https://docs.uibakery.io/reference/working-with-components/date-and-time.md

Queries the documentation for additional information.

```APIDOC
## GET /reference/working-with-components/date-and-time.md

### Description
Perform an HTTP GET request on the current page URL to query the documentation dynamically.

### Method
GET

### Endpoint
https://docs.uibakery.io/reference/working-with-components/date-and-time.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask.
- **goal** (string) - Optional - The broader end goal to tailor the answer.
```

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

### GET /build-from-scratch.md

Source: https://docs.uibakery.io/build-from-scratch.md

Performs a dynamic query against the documentation to retrieve answers, excerpts, and sources based on a specific question and optional goal.

```APIDOC
## GET /build-from-scratch.md

### Description
Queries the documentation dynamically to retrieve information not explicitly present on the current page. This allows for context-aware answers based on a specific question and an optional broader goal.

### Method
GET

### Endpoint
https://docs.uibakery.io/build-from-scratch.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask in natural language.
- **goal** (string) - Optional - The broader end goal to help tailor the response relevance.
```

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

### GET /reference/working-with-components/modal.md

Source: https://docs.uibakery.io/reference/working-with-components/modal.md

Query the documentation for the Modal component dynamically.

```APIDOC
## GET /reference/working-with-components/modal.md

### Description
Perform a query to retrieve additional information about the Modal component or related documentation.

### Method
GET

### Endpoint
https://docs.uibakery.io/reference/working-with-components/modal.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific question to ask.
- **goal** (string) - Optional - The broader end goal for the query.
```

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

### GET /on-premise/install-and-update/recommendations/resource-optimization.md

Source: https://docs.uibakery.io/on-premise/install-and-update/recommendations/resource-optimization.md

Queries the documentation page for specific information using a natural language question.

```APIDOC
## GET /on-premise/install-and-update/recommendations/resource-optimization.md

### Description
Performs a dynamic query against the documentation page to retrieve answers, excerpts, and sources based on a provided question.

### Method
GET

### Endpoint
https://docs.uibakery.io/on-premise/install-and-update/recommendations/resource-optimization.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

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

### GET /reference/working-with-actions/dynamodb-request.md

Source: https://docs.uibakery.io/reference/working-with-actions/dynamodb-request.md

Query the documentation dynamically by asking a question.

```APIDOC
## GET /reference/working-with-actions/dynamodb-request.md

### Description
Perform an HTTP GET request on the current page URL to query the documentation dynamically.

### Method
GET

### Endpoint
https://docs.uibakery.io/reference/working-with-actions/dynamodb-request.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question in natural language.
- **goal** (string) - Optional - Describes the broader end goal to tailor the answer.
```

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

### Query documentation via HTTP GET

Source: https://docs.uibakery.io/concepts/workspace-management/interface.md

Use this request to fetch answers and relevant documentation excerpts dynamically.

```http
GET https://docs.uibakery.io/concepts/workspace-management/interface.md?ask=<question>&goal=<endgoal>
```

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

### Filter Condition Example

Source: https://docs.uibakery.io/reference/working-with-actions/update-row-action.md

Specifies the row identifier for the update operation.

```javascript
// id = 23
{{ui.table.updatedRow.data.id}}
```

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

### GET /reference/working-with-components/text.md

Source: https://docs.uibakery.io/reference/working-with-components/text.md

Queries the documentation dynamically using natural language.

```APIDOC
## GET /reference/working-with-components/text.md

### Description
Perform an HTTP GET request on the current page URL to query the documentation dynamically.

### Method
GET

### Endpoint
https://docs.uibakery.io/reference/working-with-components/text.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask.
- **goal** (string) - Optional - The broader end goal to tailor the answer.
```

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

### GET /reference/working-with-components/iframe.md

Source: https://docs.uibakery.io/reference/working-with-components/iframe.md

Queries the documentation dynamically using natural language.

```APIDOC
## GET /reference/working-with-components/iframe.md

### Description
Performs a query on the documentation to retrieve information or clarification.

### Method
GET

### Endpoint
/reference/working-with-components/iframe.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific question to ask.
- **goal** (string) - Optional - The broader end goal to tailor the answer.
```

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

### GET /extras/ui-bakery-storage/on-premise-setup.md

Source: https://docs.uibakery.io/extras/ui-bakery-storage/on-premise-setup.md

Queries the documentation page for specific information using a natural language question.

```APIDOC
## GET /extras/ui-bakery-storage/on-premise-setup.md

### Description
Queries the documentation dynamically by providing a question and an optional goal to receive a direct answer with relevant excerpts.

### Method
GET

### Endpoint
https://docs.uibakery.io/extras/ui-bakery-storage/on-premise-setup.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

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

### Start UI Bakery service containers

Source: https://docs.uibakery.io/on-premise/install-and-update/installing-on-premise-version/manual-w-docker-run.md

Launch individual UI Bakery service containers using the shared network and environment configuration.

```bash
docker run -d \
  --name bakery-back \
  --env-file .env \
  --restart always \
  --network ui-bakery-on-premise \
  cruibakeryonprem.azurecr.io/cloud/bakery-back:latest
```

```bash
docker run -d \
  --name workbench-front \
  --env-file .env \
  --restart always \
  --network ui-bakery-on-premise \
  cruibakeryonprem.azurecr.io/cloud/workbench-front:latest
```

```bash
docker run -d \
  --name bakery-front \
  --env-file .env \
  --restart always \
  --network ui-bakery-on-premise \
  cruibakeryonprem.azurecr.io/cloud/bakery-front:latest
```

```bash
docker run -d \
  --name datasource \
  --env-file .env \
  --restart always \
  --network ui-bakery-on-premise \
  cruibakeryonprem.azurecr.io/cloud/datasource:latest
```

```bash
docker run -d \
  --name python-runtime \
  --env-file .env \
  --restart always \
  --network ui-bakery-on-premise \
  cruibakeryonprem.azurecr.io/cloud/python-runtime:latest
```

```bash
docker run -d \
  --name automation \
  --env-file .env \
  --restart always \
  --network ui-bakery-on-premise \
  cruibakeryonprem.azurecr.io/cloud/automation:latest
```

```bash
docker run -d \
  --name gateway \
  --env-file .env \
  -p ${UI_BAKERY_PORT:-3030}:3030 \
  --restart always \
  --network ui-bakery-on-premise \
  cruibakeryonprem.azurecr.io/cloud/gateway:latest
```

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

### GET /reference/working-with-components/email-input.md

Source: https://docs.uibakery.io/reference/working-with-components/email-input.md

Query the documentation for the Email Input component dynamically.

```APIDOC
## GET /reference/working-with-components/email-input.md

### Description
Query the documentation dynamically by asking a question related to the Email Input component.

### Method
GET

### Endpoint
https://docs.uibakery.io/reference/working-with-components/email-input.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask.
- **goal** (string) - Optional - The broader end goal to tailor the answer.
```

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

### Query Documentation via HTTP GET

Source: https://docs.uibakery.io/build-from-scratch/getting-started/link-components.md

Use this request to ask questions about the documentation dynamically by appending the ask and goal parameters to the page URL.

```http
GET https://docs.uibakery.io/build-from-scratch/getting-started/link-components.md?ask=<question>&goal=<endgoal>
```

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

### GET /reference/working-with-components/container.md

Source: https://docs.uibakery.io/reference/working-with-components/container.md

Queries the documentation dynamically using natural language.

```APIDOC
## GET /reference/working-with-components/container.md

### Description
Perform an HTTP GET request on the current page URL to query the documentation dynamically.

### Method
GET

### Endpoint
https://docs.uibakery.io/reference/working-with-components/container.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask.
- **goal** (string) - Optional - The broader end goal to tailor the answer.
```

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

### GET /build-from-scratch.md

Source: https://docs.uibakery.io/llms.txt

Performs a natural language query against the documentation index to retrieve an answer and relevant sources.

```APIDOC
## GET /build-from-scratch.md

### Description
Perform an HTTP GET request on the documentation index with the `ask` parameter, and the optional `goal` parameter to receive a direct answer and relevant excerpts.

### Method
GET

### Endpoint
https://docs.uibakery.io/build-from-scratch.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - Describes the broader end goal to tailor the answer.
```

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

### GET /reference/working-with-components/chat.md

Source: https://docs.uibakery.io/reference/working-with-components/chat.md

Perform a query against the documentation to retrieve information or clarification.

```APIDOC
## GET /reference/working-with-components/chat.md

### Description
Queries the documentation dynamically to retrieve answers, excerpts, or context related to the documentation content.

### Method
GET

### Endpoint
https://docs.uibakery.io/reference/working-with-components/chat.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

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

### GET /reference/working-with-components/boolean.md

Source: https://docs.uibakery.io/reference/working-with-components/boolean.md

Query the documentation dynamically using natural language.

```APIDOC
## GET /reference/working-with-components/boolean.md

### Description
Perform a query against the documentation to retrieve answers or context.

### Method
GET

### Endpoint
/reference/working-with-components/boolean.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

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

### Query documentation via HTTP GET

Source: https://docs.uibakery.io/concepts/components/custom-component.md

Use this request format to ask specific questions and provide context for the desired end goal.

```http
GET https://docs.uibakery.io/concepts/components/custom-component.md?ask=<question>&goal=<endgoal>
```

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

### GET /on-premise/on-premise-features/embedding.md

Source: https://docs.uibakery.io/on-premise/on-premise-features/embedding.md

Queries the documentation dynamically to retrieve information or clarification.

```APIDOC
## GET /on-premise/on-premise-features/embedding.md

### Description
Performs a query against the documentation to retrieve answers or context related to the page content.

### Method
GET

### Endpoint
/on-premise/on-premise-features/embedding.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

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

### Get database credentials

Source: https://docs.uibakery.io/extras/ui-bakery-postgres/database-migration.md

Fetch the credentials for a specific datasource ID.

```sql
SELECT credentials FROM datasource_credentials WHERE datasource_id=7;
```

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

### Start internal MySQL database container

Source: https://docs.uibakery.io/on-premise/install-and-update/installing-on-premise-version/manual-w-docker-run.md

Launch the MySQL database for storing metadata if an external database is not used.

```bash
docker run -d \
  --name db \
  --restart always \
  --platform linux/amd64 \
  --cap-add SYS_NICE \
  --env-file .env \
  -e MYSQL_DATABASE=bakery \
  -e MYSQL_USER=bakery \
  -e MYSQL_PASSWORD=bakery \
  -e MYSQL_ROOT_PASSWORD=root \
  -v my-db:/var/lib/mysql \
  --health-cmd 'mysql -h localhost -u bakery --password=bakery -e "select 1"' \
  --health-timeout 1s \
  --health-interval 10s \
  --health-retries 10 \
  --network=ui-bakery-on-premise \
  mysql:8.0 --default-authentication-plugin=mysql_native_password
```

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

### Query documentation via HTTP GET

Source: https://docs.uibakery.io/on-premise/environment-variables.md

Use this request to ask questions dynamically against the documentation page.

```http
GET https://docs.uibakery.io/on-premise/environment-variables.md?ask=<question>&goal=<endgoal>
```
Tokens:
Raw