### Example: Display robot data with SweetAlert2

Source: https://docs.rocketbot.com/2024/01/22/how-to-send-data-to-xperience?print=print

This example shows an alert with the data returned from the robot. Requires adding the SweetAlert2 CDN: //cdn.jsdelivr.net/npm/sweetalert2@11. Handles both success and error cases.

```javascript
rocket.on('change', (xperience, res) => {                                                                        
  if (res.success) {
    console.log('RES: ',res) // esta línea te permite ver el resultado en la consola del formulario
    if(res.data){
       swal.fire({
        title: 'Estos son los datos enviados desde el robot ' + res.data,
        icon: 'info',
      });
    }
  }else{
     swal.fire({
        title: 'Ocurrió un error al solicitar datos',
        icon: 'error'
      });
 }

}); 
```

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

### Response example for get form data from queue

Source: https://docs.rocketbot.com/2024/09/18/orquestador-rocketbot-apis-xperience

Shows the JSON response with a success flag and data object containing the queue id, form data as a JSON string, user_form_email, and an encrypted xperience token.

```json
{
    "success": true,
    "data": {
        "id": 8728,
        "data": "{\"Dato1\":\"prueba\",\"Dato2\":\"prueba1\"}",
        "user_form_email": null,
        "xperience": "eyJpdiI6InNxMXhRekhVUUJrWVptcGpzOUM1aXc9PSIsInZhbHVlIjoiY1NoMGtpcW5udk5vTmZxVlVYZFg1V29CUGU4SDB1UVUwWXFuYVNMb2FVNkE2OE5MMnRwelorWGxtMU9VZ2pjTGJnSUNLaE5cL1ArSkpPdk1BendRYVlvTlMyU0QwclNxN0E2VENmSDEyZTJRPSIsIm1hYyI6ImYyYjc2ZmM3OTAwMWQzNDVlMmViNmM1NTIxNjc0OTc0Y2IwOTA2Yjg4YTMwODNlODUwNzU1NWQ4MmM2ZGRmMjcifQ=="
    }
}
```

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

### List Projects Response Example

Source: https://docs.rocketbot.com/2024/09/18/orquestador-rocketbot-apis-xperience

A sample JSON response returned by the project list endpoint.

```json
{
    "success": true,
    "data": [
        {
            "name": "test orquestador",
            "token": "JR0EYGNSXEMTQWUP",
            "created_at": "2024-08-15 08:42:16",
            "id": 69,
            "description": null,
            "process_count": 1,
            "process": [
                {
                    "id": 168,
                    "project_id": 69,
                    "token": "1KZQIJKTTR75CGWF",
                    "name": "bot orquestador",
                    "last_robot": {
                        "id": 143,
                        "name": "bot orquestador",
                        "user_id": 67,
                        "client_id": 3,
                        "cron": null,
                        "version": null,
                        "version_rocketbot": null,
                        "robot": "myrb_clients/dev/project/69/process/168/robot/rocket.bot",
                        "md5": "7af04cc5dbbea2e6ff1f27c183ef4772",
                        "comment": null,
                        "type": 1,
                        "status": 0,
                        "process_id": 168,
                        "start_bot": "bot_orquestador",
                        "created_at": "2024-08-21 09:37:50",
                        "updated_at": "2024-08-21 09:37:50"
                    },
                    "backup": null,
                    "trigger_process": null,
                    "client": null,
                    "robots": [
                        {
                            "id": 143,
                            "name": "bot orquestador",
                            "user_id": 67,
                            "client_id": 3,
                            "cron": null,
                            "version": null,
                            "version_rocketbot": null,
                            "robot": "myrb_clients/dev/project/69/process/168/robot/rocket.bot",
                            "md5": "7af04cc5dbbea2e6ff1f27c183ef4772",
                            "comment": null,
                            "type": 1,
                            "status": 0,
                            "process_id": 168,
                            "start_bot": "bot_orquestador",
                            "created_at": "2024-08-21 09:37:50",
                            "updated_at": "2024-08-21 09:37:50"
                        }
                    ]
                }
            ]
        }
    ]
}
```

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

### Standard Implementation

Source: https://docs.rocketbot.com/category/saturn/sistema-saturn?print=print-search

Basic setup of the Saturn Studio chat widget with default values. Ideal for quick integration.

```APIDOC
## SaturnStudioChatWidget - Standard Implementation

### Description
Basic configuration of the Saturn Studio chat widget with default values. Ideal for starting quickly.

### Usage
Include the widget script and instantiate the SaturnStudioChatWidget with the required chatUrl parameter.

### Parameters
- **chatUrl** (string) - Required - The URL of the chat obtained from Saturn Studio.

### Example
```html
<!DOCTYPE html>
<html>
  <head>
    <title>Su Sitio Web</title>
  </head>
  <body>
    <main>
      <!-- Su contenido existente -->
    </main>

    <!-- Integración del Widget de Saturn Studio -->
    <script src="https://studio.rocketbot.com/chat-widget.js"></script>
    <script>
      new SaturnStudioChatWidget({
        chatUrl: "https://studio.rocketbot.com/chat/bcc41e580..."
      });
    </script>
  </body>
</html>
```
```

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

### List Projects cURL Request

Source: https://docs.rocketbot.com/2024/09/18/orquestador-rocketbot-apis-xperience

Example of how to list projects using a cURL command with Bearer token authentication.

```bash
curl --location --request POST 'https://www.myrb.io/dev/api/project/list' \
--header 'Authorization: 'Authorization: Bearer <token>'
```

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

### List Projects Python Request

Source: https://docs.rocketbot.com/2024/09/18/orquestador-rocketbot-apis-xperience

Example of how to list projects using the Python requests library.

```python
import requests

url = "https://www.myrb.io/dev/api/project/list"

payload = {}
headers = {
  'Authorization': 'Bearer <token>'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)
```

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

### Add User-Agent header to Python requests

Source: https://docs.rocketbot.com/2019/12/20/tips-comandos-rocketbot?print=print

When a GET request fails with RemoteDisconnected, add a User-Agent header to the request. The example shows setting headers and making the request.

```python
headers = {
   'User-Agent': 'My User Agent 1.0',
}
data = requests.get(URL_, headers=headers)
data = data.json()
```

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

### Install Evolution API with Docker

Source: https://docs.rocketbot.com/2026/02/19/saturn-studio-evolution-api-whatsapp-2

Use this command to deploy the Evolution API server container. Replace 'su-api-key-aqui' with your actual API key.

```bash
docker run -d \
    --name evolution_api \
    -p 8080:8080 \
    -e AUTHENTICATION_API_KEY=su-api-key-aqui \
    atendai/evolution-api:latest
```

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

### Response example for get all queue IDs

Source: https://docs.rocketbot.com/2024/09/18/orquestador-rocketbot-apis-xperience

Shows the JSON response structure with a success flag and an array of queue objects, each containing an id and null fields for form-related data.

```json
{
    "success": true,
    "data": [
        {
            "id": 4734,
            "form_name": null,
            "user_form_email": null,
            "locked_user": null,
            "form_token": null,
            "form": null,
            "user_form": null,
            "locker": null
        },
        {
            "id": 4735,
            "form_name": null,
            "user_form_email": null,
            "locked_user": null,
            "form_token": null,
            "form": null,
            "user_form": null,
            "locker": null
        },

    ]
}
```

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

### Archivo robot.sh para ejecutar Rocketbot en MacOS y Linux

Source: https://docs.rocketbot.com/2019/12/19/crear-tarea-programada

Crea un archivo .sh con la ruta de instalación de Rocketbot y el comando -start= seguido del nombre del robot. Este archivo se usará con cron.

```bash
cd user/ruta/rocketbot/  
 rocketbot -start=nombre_del_robot
```

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

### Get form by ID

Source: https://docs.rocketbot.com/2026/03/27/saturn-studio-xperience?print=print

Gets the technical information of a specific form.

```APIDOC
## Get form by ID

### Description
Gets the technical information of a specific form.

### Parameters
- **Credential** (string) - Required - Credencial de Orquestador necesaria para la consulta. Example: `orchestrator - Test`
- **Form ID** (string) - Required - Identificador único (token) del formulario. Example: `VGJBQ9DBICYZ4CB`
- **Assign result to a Variable** (string) - Required - Variable donde se guardarán los detalles del formulario. Example: `{form_details}`
```

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

### POST /odata/Jobs/UiPath.Server.Configuration.OData.StartJobs - Ejecutar proceso UiPath

Source: https://docs.rocketbot.com/2025/04/11/ejecucion-de-automatizaciones-desde-linea-de-comandos-y-api

Inicia un proceso en UiPath Orchestrator mediante la API REST.

```APIDOC
## POST /odata/Jobs/UiPath.Server.Configuration.OData.StartJobs

### Description
Inicia un proceso en UiPath Orchestrator. Requiere el ReleaseKey del proceso y opcionalmente parámetros de entrada.

### Method
POST

### Endpoint
/odata/Jobs/UiPath.Server.Configuration.OData.StartJobs

### Parameters
#### Headers
- **Authorization** (string) - Required - Token de autenticación en formato Bearer.

#### Request Body
- **startInfo** (object) - Required - Información para iniciar el trabajo.
  - **ReleaseKey** (string) - Required - Clave del release del proceso.
  - **Strategy** (string) - Required - Estrategia de ejecución (ej. Specific).
  - **RobotIds** (array of integer) - Optional - IDs de los robots a utilizar.
  - **InputArguments** (string) - Optional - Argumentos de entrada en formato JSON.

### Request Example
```json
{
  "startInfo": {
    "ReleaseKey": "<releaseKey>",
    "Strategy": "Specific",
    "RobotIds": [1234],
    "InputArguments": "{\"param\":\"value\"}"
  }
}
```

### Response
#### Success Response
No se especifica la estructura de respuesta en la documentación.
```

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

### Run Task

Source: https://docs.rocketbot.com/2025/04/10/saturn-studio-aistudio

Ejecuta una tarea específica en AiStudio. Permite elegir el modo de ejecución (WAIT o BACKGROUND) y opcionalmente especificar fechas para tareas de tipo EMAIL o un archivo de entrada.

```APIDOC
## Run Task

### Description
Ejecuta una tarea específica en AiStudio.

### Parameters
- **Credencial** (string) - Requerido - Credencial de AiStudio necesaria para ejecutar una tarea.
- **ID de tarea** (string) - Requerido - Selecciona la tarea que deseas ejecutar.
- **Modo de ejecución** (string) - Requerido - Modo de ejecución de la tarea. `WAIT` espera la finalización y devuelve el resultado. `BACKGROUND` la ejecuta en segundo plano.
- **Fecha de inicio (Email task)** (date) - Opcional - Fecha desde la cual se buscarán correos. Obligatoria si la tarea es de tipo EMAIL.
- **Fecha de fin (Email task)** (date) - Opcional - Fecha hasta la cual se buscarán correos. Obligatoria si la tarea es de tipo EMAIL.
- **Ruta de archivo** (string) - Opcional - Archivo que se enviará a la tarea. Requerido si la tarea lo necesita.
- **Asignar resultado a variable** (variable) - Opcional - Variable donde se almacenará el resultado. Ejemplo: {"status":true,"message":"Task ran in WAIT mode","data":[{"fileName":"recipe.mp3","result":{"prompt_task":true,"extraData":"{}","type":"message","template_results":{"is_recipe":true,"ingredients":"tres pechugas de pollo, sal, pimienta negra, dos huevos, 200 ml de crema, media cebolla, ajo en polvo, pimentón, mozzarella rallada, queso parmesano"},"length":971}}]}

### Response
#### Success Response
- **status** (boolean) - Indica si la ejecución fue exitosa.
- **message** (string) - Mensaje descriptivo del resultado.
- **data** (array) - Lista de resultados de la tarea.
  - **fileName** (string) - Nombre del archivo procesado.
  - **result** (object) - Resultado de la tarea.
    - **prompt_task** (boolean) - Indica si la tarea fue procesada.
    - **extraData** (string) - Datos adicionales.
    - **type** (string) - Tipo de resultado.
    - **template_results** (object) - Resultados de la plantilla.
      - **is_recipe** (boolean) - Indica si es una receta.
      - **ingredients** (string) - Lista de ingredientes.
    - **length** (number) - Duración o tamaño.

#### Response Example
{"status":true,"message":"Task ran in WAIT mode","data":[{"fileName":"recipe.mp3","result":{"prompt_task":true,"extraData":"{}","type":"message","template_results":{"is_recipe":true,"ingredients":"tres pechugas de pollo, sal, pimienta negra, dos huevos, 200 ml de crema, media cebolla, ajo en polvo, pimentón, mozzarella rallada, queso parmesano"},"length":971}}]}
```

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

### Get form by ID

Source: https://docs.rocketbot.com/2026/03/27/saturn-studio-xperience

Gets the technical information of a specific form using its unique token identifier.

```APIDOC
## Get form by ID

### Description
Obtiene la información técnica de un formulario específico.

### Parameters
- **Credential** (string) - Required - Credencial de Orquestador necesaria para la consulta. Ejemplo: `orchestrator - Test`
- **Form ID** (string) - Required - Identificador único (token) del formulario. Ejemplo: `VGJBQ9DBICYZ4CB`
- **Assign result to a Variable** (string) - Required - Variable donde se guardarán los detalles del formulario. Ejemplo: `{form_details}`
```

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

### GET /v3/automations y GET /v3/users

Source: https://docs.rocketbot.com/2025/04/11/ejecucion-de-automatizaciones-desde-linea-de-comandos-y-api?print=print

Obtiene IDs de automatizaciones y usuarios en Automation Anywhere.

```APIDOC
## GET /v3/automations

### Description
Obtiene la lista de automatizaciones disponibles en Automation Anywhere.

### Method
GET

### Endpoint
/v3/automations

### Response
#### Success Response (200)
- Lista de automatizaciones con sus IDs.

## GET /v3/users

### Description
Obtiene la lista de usuarios en Automation Anywhere.

### Method
GET

### Endpoint
/v3/users

### Response
#### Success Response (200)
- Lista de usuarios con sus IDs.
```

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

### PAD.Console.Host.exe - Ejecución desde línea de comandos Power Automate

Source: https://docs.rocketbot.com/2025/04/11/ejecucion-de-automatizaciones-desde-linea-de-comandos-y-api

Comandos CLI para ejecutar flujos de escritorio de Power Automate.

```APIDOC
## PAD.Console.Host.exe

### Description
Ejecuta flujos de escritorio de Power Automate desde la línea de comandos.

### Method
CLI

### Endpoint
PAD.Console.Host.exe

### Parameters
#### Command Line Arguments
- **workflowName** (string) - Optional - Nombre del flujo a ejecutar.
- **workflowId** (string) - Optional - ID del flujo a ejecutar.
- **inputArguments** (string) - Optional - Parámetros de entrada en formato JSON.
- **autologin** (boolean) - Optional - Indica si se debe iniciar sesión automáticamente.

### Request Example
```
"C:\Program Files (x86)\Power Automate Desktop\PAD.Console.Host.exe" "ms-powerautomate:/console/flow/run?workflowName=NombreDelFlujo"
PAD.Console.Host.exe "ms-powerautomate:/console/flow/run?workflowId=<id>&inputArguments={\"param1\":\"value1\"}&autologin=true"
```

### Response
#### Success Response
No se especifica una respuesta en la documentación.
```

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

### Get current working directory

Source: https://docs.rocketbot.com/2019/12/20/tips-comandos-rocketbot?print=print

Use in 'Asignar Variable' command to get the current working directory.

```python
os.getcwd()
```

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

### Instalar herramientas de línea de comandos de Xcode

Source: https://docs.rocketbot.com/2022/10/05/instalacion-rocketbot-en-macos?print=print

Instrucción para instalar las herramientas necesarias de Xcode desde la terminal.

```bash
xcode-select --install
```

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

### Get job data

Source: https://docs.rocketbot.com/2026/03/27/saturn-studio-xperience

Gets detailed information of a specific task or job within the transactional flow of the Xperience module.

```APIDOC
## Get job data

### Description
Obtiene la información detallada de una tarea o “job” específico dentro del flujo transaccional del módulo Xperience.

### Parameters
- **Credential** (string) - Required - Credencial de Orquestador necesaria para la conexión. Ejemplo: `orchestrator - Test`
- **Select form** (string) - Required - Menú desplegable para seleccionar el formulario asociado al trabajo. Ejemplo: `testumr`
- **Queue ID** (string) - Required - Identificador numérico de la cola; permite el uso de variables `{x}`. Ejemplo: `12152` o `{id}`
- **Assign result to a Variable** (string) - Required - Variable de Saturn Studio donde se almacenará el resultado de la consulta. Ejemplo: `{job_data}`
```

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

### POST /odata/Jobs/UiPath.Server.Configuration.OData.StartJobs

Source: https://docs.rocketbot.com/2025/04/11/ejecucion-de-automatizaciones-desde-linea-de-comandos-y-api?print=print

Inicia un trabajo (job) en UiPath Orchestrator para ejecutar un proceso.

```APIDOC
## POST /odata/Jobs/UiPath.Server.Configuration.OData.StartJobs

### Description
Inicia un trabajo en UiPath Orchestrator para ejecutar un proceso específico.

### Method
POST

### Endpoint
/odata/Jobs/UiPath.Server.Configuration.OData.StartJobs

### Headers
- `Authorization` (string) - Requerido - Bearer token.

### Request Body
- `startInfo.ReleaseKey` (string) - Requerido - Release Key del proceso.
- `startInfo.Strategy` (string) - Requerido - Estrategia de ejecución (ej. Specific).
- `startInfo.RobotIds` (array of integers) - Opcional - IDs de robots.
- `startInfo.InputArguments` (string) - Opcional - Argumentos de entrada en formato JSON.

### Request Example
```json
{
  "startInfo": {
    "ReleaseKey": "<releaseKey>",
    "Strategy": "Specific",
    "RobotIds": [1234],
    "InputArguments": "{\"param\":\"value\"}"
  }
}
```
```

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

### Get job data

Source: https://docs.rocketbot.com/2026/03/27/saturn-studio-xperience?print=print

Gets detailed information of a specific task or 'job' within the transactional flow of the Xperience module.

```APIDOC
## Get job data

### Description
Gets detailed information of a specific task or 'job' within the transactional flow of the Xperience module.

### Parameters
- **Credential** (string) - Required - Credencial de Orquestador necesaria para la conexión. Example: `orchestrator - Test`
- **Select form** (string) - Required - Menú desplegable para seleccionar el formulario asociado al trabajo. Example: `testumr`
- **Queue ID** (string) - Required - Identificador numérico de la cola; permite el uso de variables `{x}`. Example: `12152` o `{id}`
- **Assign result to a Variable** (string) - Required - Variable de Saturn Studio donde se almacenará el resultado de la consulta. Example: `{job_data}`
```

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

### POST /v3/automations/deploy

Source: https://docs.rocketbot.com/2025/04/11/ejecucion-de-automatizaciones-desde-linea-de-comandos-y-api?print=print

Ejecuta un bot en Automation Anywhere mediante API.

```APIDOC
## POST /v3/automations/deploy

### Description
Ejecuta un bot en Automation Anywhere mediante API.

### Method
POST

### Endpoint
/v3/automations/deploy

### Headers
- `Authorization` (string) - Requerido - Bearer token.

### Request Body
- `fileId` (string) - Requerido - ID del bot.
- `runAsUserIds` (array of strings) - Requerido - IDs de usuarios.
- `botInput` (object) - Opcional - Parámetros de entrada.

### Request Example
```json
{
  "fileId": "<bot_id>",
  "runAsUserIds": ["<user_id>"],
  "botInput": {
    "param1": "value1"
  }
}
```
```

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

### Process Transaction TryCatch Structure

Source: https://docs.rocketbot.com/2024/07/17/rocketbot-transaction-framework?print=print

Mandatory structure for the Process Transaction robot. The Try block contains transaction handling commands and must end with a variable assignment incrementing TransactionNumber and a Return Information command returning TransactionItem and TransactionNumber. The Catch block starts with Last State to get the error code into Status, assigns the error message to Exception, and then uses an IF to check for 'Unable to locate element' to return a BusinessException or the full Status for a System Exception.

```plaintext
[Bloque TryCatch]
    Try:
        # Acá van los comandos que realizarán el proceso de la transacción
        [Comandos de manejo de transación]

        # Al final del try de manera obligatoria deben ir dos comandos: 
        # Asignar variable que sume uno a **TransactionNumber**
        # El comando **Retornar Información** que devuelva **TransactionItem** y  
        # **TransactionNumber**, junto con cualquier otro contenido opcional
        [Retornar Informacion: **Datos** {"TransactionItem": "{TransactionItem}",
         "TransactionNumber": "{TransactionNumber}"}]

    Catch:
        # El primer comando del Catch debe ser Último Estado.
        # De esta manera obtenemos el código del error que pueda suceder y
        # lo asignamos a la variable Status
        [Último Estado: **Variable** Status]

        # Luego asignamos a la variable **Exception** el mensaje del error
        [Asignar Variable: {Status}.get('message')
         **Dest: Exception**]

        # En este punto se deben establecer las reglas de negocio. En la db de
        # ejemplo se utiliza un IF que comprueba si en el mensaje del error que 
        # ocurrió se encuentra el texto "Unable to locate element". Este error es 
        # muy común en automatizaciones web cuando un elemento no puede ser ubicado 
        # en la página. A veces se soluciona con un reintento, entonces quiero 
        # establecer este caso como un **Business Exception.** 
        IF: **"Unable to locate element" in """{Exception}"""**
            True:
                # En este punto debemos retornar un diccionario con, al menos, la
                # llave **BusinessException **que contenga el texto del error.
                [Retornar informacion: **Datos **{'BusinessException': '{Exception}'}]
            False:
                # Si llegamos a este punto es porque es un error no controlado.
                # Por lo tanto, debemos retornar todo el contenido de la variable
                # **Status**, generando un **System Exception**.
                [Retornar informacion: **Datos **{Status}]
```

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

### Obtener Tabla (Get Table)

Source: https://docs.rocketbot.com/category/saturn/page/2?print=print-search

Gets a table by its table ID. Requires a Nexus credential and the table ID, and assigns the result to a variable.

```APIDOC
## Obtener Tabla (Get Table)

### Description
Gets a table by its table ID.

### Parameters
- **Credencial** (string) - Required - Nexus credential needed to obtain the table.
- **ID de la Tabla** (string) - Required - ID of the table to get.
- **Asignar resultado a variable** (variable) - Required - Variable where the result will be stored.

### Response Example
```json
{"id": "46y1fd89-6f42-4c74-b473-cb542100a8t0", "appId": "3l106408-6b80-49de-8dcb-0cba1bf102d4", "name": "My Table", "displayName": "custom", "schema": {"columns": [{"name": "name", "type": "string", "displayName": "Name"}]}, "createdAt": "2024-10-01T120000Z", "updatedAt": "2024-10-01T120000Z"}
```
```

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

### PAD.Console.Host.exe

Source: https://docs.rocketbot.com/2025/04/11/ejecucion-de-automatizaciones-desde-linea-de-comandos-y-api?print=print

Ejecuta flujos de escritorio de Power Automate desde línea de comandos.

```APIDOC
## PAD.Console.Host.exe

### Description
Ejecuta flujos de escritorio de Power Automate desde la línea de comandos.

### Method
CLI

### Command
PAD.Console.Host.exe

### Parameters
- `workflowName` (string) - Opcional - Nombre del flujo.
- `workflowId` (string) - Opcional - ID del flujo.
- `inputArguments` (string) - Opcional - Argumentos de entrada en formato JSON.
- `autologin` (boolean) - Opcional - Indica si se debe iniciar sesión automáticamente.

### Examples
```
"C:\Program Files (x86)\Power Automate Desktop\PAD.Console.Host.exe" "ms-powerautomate:/console/flow/run?workflowName=NombreDelFlujo"
PAD.Console.Host.exe "ms-powerautomate:/console/flow/run?workflowId=<id>&inputArguments={\"param1\":\"value1\"}&autologin=true"
```
```

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

### Get the value of a Key from Redis

Source: https://docs.rocketbot.com/2026/06/02/saturn-studio-redis

Gets the value of a key from Redis. Requires a Redis credential, the key, and the key type. The result is stored in a variable.

```APIDOC
## Get the value of a Key from Redis

### Description
Gets the value of a key from Redis.

### Parameters
- **Credential** (string) - Required - Redis credential needed to get the value of a key.
- **Key** (string) - Required - The key to get from Redis.
- **Key Type** (string) - Required - The data type of the key in Redis. Possible values: Hash, List, Sets, String.
- **Assign result to variable** (string) - Required - Variable where the result will be stored. Example: {"key" "mykey", "type" "string", "found" true, "value" "myvalue"}

### Example
Credential: `credential`
Key: `mykey`
Key Type: `Hash, List, Sets, String`
Assign result to variable: `{var}`
```

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

### Create a folder from Rocket

Source: https://docs.rocketbot.com/2019/12/20/tips-comandos-rocketbot?print=print

Use in 'Asignar Variable' command to create a directory. Replace 'C:/el/path' with the desired path.

```python
os.mkdir("C:/el/path")
```

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

### Get Ticket

Source: https://docs.rocketbot.com/2026/06/02/saturn-studio-otobo

Gets a ticket by ID from Otobo. Requires an Otobo credential, ticket ID, web service, and operation path. The result can be assigned to a variable.

```APIDOC
## Get Ticket

### Description
Gets a ticket by ID from Otobo.

### Parameters

| Parameter | Description | Example |
|-----------|-------------|---------|
| Credential | Otobo credential needed to get the ticket. | `credential` |
| Ticket ID | ID of the ticket to get. | `8453` |
| Web Service | Web service used to get the ticket. | `Web Service` |
| Operation Path | Operation path in the web service. Example: Ticket or TicketGet. | `Operation Path` |
| Assign result to variable | Variable where the result will be stored. | `{var}` |
```

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

### Iniciar Rocketbot Studio en Windows

Source: https://docs.rocketbot.com/2018/09/09/abrir-rocketbot-studio

Método para ejecutar la aplicación mediante el archivo ejecutable.

```text
rocketbot.exe
```

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

### GET /v3/automations y GET /v3/users - Obtener IDs Automation Anywhere

Source: https://docs.rocketbot.com/2025/04/11/ejecucion-de-automatizaciones-desde-linea-de-comandos-y-api

Obtiene los IDs de automatizaciones y usuarios necesarios para ejecutar un bot.

```APIDOC
## GET /v3/automations y GET /v3/users

### Description
Obtiene los IDs de automatizaciones y usuarios necesarios para ejecutar un bot.

### Method
GET

### Endpoint
/v3/automations
/v3/users

### Parameters
#### Headers
- **Authorization** (string) - Required - Token de autenticación en formato Bearer.

### Request Example
```
GET /v3/automations
GET /v3/users
```

### Response
#### Success Response
No se especifica la estructura de respuesta en la documentación.
```

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

### Get total rows of a table

Source: https://docs.rocketbot.com/2019/12/20/tips-comandos-rocketbot?print=print

Use in 'Ejecuta JS' command to get the number of rows in a table with a specific class. Replace 'tabla_indicadores' with the actual class name.

```javascript
document.getElementsByClassName('tabla_indicadores')[4].getElementsByTagName("tr").length;
```

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

### Script .bat para ejecutar Rocketbot al desconectarse del servidor (tscon.exe + rocketbot.exe)

Source: https://docs.rocketbot.com/category/ayuda/deployment?print=print-search

Variante del script anterior que, además de mantener la sesión activa, espera 10 segundos y ejecuta Rocketbot con el parámetro -start=nombre_robot. Debe ejecutarse como administrador. Ajusta la ruta c:\rocketbot y el nombre del robot según tu instalación.

```batch
@powershell -NoProfile -ExecutionPolicy unrestricted -Command "$sessionid=((quser $env:USERNAME | select -Skip 1) -split '\\s+')[2]; tscon $sessionid /dest:console" 2> UnlockErrors.log

timeout 10
cd c:\rocketbot
rocketbot.exe -start=nombre_robot

```

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

### Listar instancias de VM con gcloud

Source: https://docs.rocketbot.com/2023/11/22/despliegue-de-rocketrbot-en-gcp

Comando para listar las instancias de VM y obtener sus direcciones IP internas y externas.

```bash
gcloud compute instances list
```

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

### Power Automate CLI: Ejecución de flujos

Source: https://docs.rocketbot.com/2025/04/11/ejecucion-de-automatizaciones-desde-linea-de-comandos-y-api

Ejecuta flujos de escritorio mediante PAD.Console.Host.exe usando el nombre del flujo o su ID único.

```bash
"C:\Program Files (x86)\Power Automate Desktop\PAD.Console.Host.exe" "ms-powerautomate:/console/flow/run?workflowName=NombreDelFlujo"
```

```bash
PAD.Console.Host.exe "ms-powerautomate:/console/flow/run?workflowId=<id>&inputArguments={\"param1\":\"value1\"}&autologin=true"
```

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

### Get current day number using datetime.today().weekday()

Source: https://docs.rocketbot.com/2019/12/20/tips-comandos-rocketbot?print=print

Use in Rocketbot's 'Asignar Variable' command to get the current day of the week as a number, where Monday is 0 and Sunday is 6.

```python
datetime.today().weekday()
```

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

### Power Automate CLI: Ejecución de flujos

Source: https://docs.rocketbot.com/2025/04/11/ejecucion-de-automatizaciones-desde-linea-de-comandos-y-api?print=print

Ejecuta flujos de escritorio utilizando PAD.Console.Host.exe mediante nombre o ID.

```bash
"C:\Program Files (x86)\Power Automate Desktop\PAD.Console.Host.exe" "ms-powerautomate:/console/flow/run?workflowName=NombreDelFlujo"

PAD.Console.Host.exe "ms-powerautomate:/console/flow/run?workflowId=<id>&inputArguments={\"param1\":\"value1\"}&autologin=true"
```

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

### Get today's date with format using datetime.now

Source: https://docs.rocketbot.com/2019/12/20/tips-comandos-rocketbot?print=print

Use in Rocketbot's 'Asignar Variable' command to get the current date and time formatted as 'dd/mm/yyyy HH:MM:SS'.

```python
datetime.now().strftime("%d/%m/%Y %H:%M:%S")
```

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

### Get previous business day using datetime.today() and timedelta

Source: https://docs.rocketbot.com/2019/12/20/tips-comandos-rocketbot?print=print

Use in Rocketbot's 'Asignar Variable' command to get the previous business day. Requires a variable 'time_delta' with an array of day offsets.

```python
datetime.today() - timedelta(days={days_delta}[datetime.today().weekday()])
```

```python
time_delta = [2,3,1,1,1,1,1]
```

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

### Standard SaturnStudioChatWidget implementation

Source: https://docs.rocketbot.com/2025/12/24/saturn-studio-chat-widget?print=print

Basic HTML page setup that loads the chat widget script and initializes SaturnStudioChatWidget with the required chatUrl parameter. Ideal for quick integration with default settings.

```html
<!DOCTYPE html>
<html>
  <head>
    <title>Su Sitio Web</title>
  </head>
  <body>
    <main>
      <!-- Su contenido existente -->
    </main>

    <!-- Integración del Widget de Saturn Studio -->
    <script src="https://studio.rocketbot.com/chat-widget.js"></script>
    <script>
      new SaturnStudioChatWidget({
        chatUrl: "https://studio.rocketbot.com/chat/bcc41e580..."
      });
    </script>
  </body>
</html>
```

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

### GET /api/v1/external/queries

Source: https://docs.rocketbot.com/2026/07/27/nexus-edicion-de-aplicacion-app-overview?print=print

Lists all available queries.

```APIDOC
## GET /api/v1/external/queries

### Description
List all queries.

### Method
GET

### Endpoint
/api/v1/external/queries

### Authentication
Requires `X-API-Key` header.

### Response
#### Success Response (200)
- **queries** (array) - List of query objects.

#### Response Example
```json
{
  "queries": []
}
```
```

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

### Archivo robot.bat para ejecutar Rocketbot en Windows

Source: https://docs.rocketbot.com/2019/12/19/crear-tarea-programada

Crea un archivo .bat con la ruta de instalación de Rocketbot y el comando -start= seguido del nombre del robot. Este archivo se usará en la tarea programada de Windows.

```batch
cd C:\ruta\rocketbot\  
 rocketbot.exe -start=nombre_del_robot
```

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

### Get last day of month with Python script

Source: https://docs.rocketbot.com/2019/12/20/tips-comandos-rocketbot?print=print

Use a Python script file 'last_day.py' to get the last day of the month. The script uses GetVar to retrieve 'mes' and 'anio' variables and SetVar to store the result in 'resultado'.

```python
Archivo last_day.py
```

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

### Iniciar Rocketbot Studio en Windows

Source: https://docs.rocketbot.com/2018/09/09/abrir-rocketbot-studio?print=print

Instrucción para ejecutar la aplicación mediante el archivo ejecutable.

```text
Doble click en el icono de rocketbot.exe
```

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

### Ejecución en paralelo en Windows (.bat)

Source: https://docs.rocketbot.com/2021/08/30/ejecutar-en-paralelo?print=print

Script para iniciar múltiples robots en Windows utilizando el comando START.

```batch
cd C:/ruta/a/carpeta/Rocketbot  
 START rocketbot.exe -start=robot1  
 START rocketbot.exe -start=robot2  
```

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

### GET /api/v1/external/tables

Source: https://docs.rocketbot.com/2026/07/27/nexus-edicion-de-aplicacion-app-overview?print=print

Lists all tables available in the application.

```APIDOC
## GET /api/v1/external/tables

### Description
List all tables.

### Method
GET

### Endpoint
/api/v1/external/tables

### Authentication
Requires `X-API-Key` header.

### Response
#### Success Response (200)
- **tables** (array) - List of table objects.

#### Response Example
```json
{
  "tables": []
}
```
```

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

### Google Tasks Commands

Source: https://docs.rocketbot.com/category/saturn/page/7?print=print-search

Overview of the Google Tasks integration commands: Create Task, Get Task, Delete Task, List Tasks, Update Task, List Tasks Lists, Update List, Get List, Delete List, and Create List.

```APIDOC
## Google Tasks Commands

### Description
Commands for managing tasks and task lists in Google Tasks.

### Commands

#### Create Task
Creates a new entry in a specific task list.

#### Get Task
Retrieves detailed information of a specific task.

#### Delete Task
Removes an existing task from a given list.

#### List Tasks
Returns all tasks present in a specific list.

#### Update Task
Modifies the attributes of an already created task.

#### List Tasks Lists
Enumerates the available task containers or lists in the account.

#### Update List
Renames or modifies a task list.

#### Get List
Queries the specific details of a task list.

#### Delete List
Deletes an entire list and all tasks contained in it.

#### Create List
Creates a new task list in the linked account.
```

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

### UiPath CLI: Comandos básicos de UiRobot.exe

Source: https://docs.rocketbot.com/2025/04/11/ejecucion-de-automatizaciones-desde-linea-de-comandos-y-api?print=print

Ejecuta procesos de UiPath mediante la herramienta UiRobot.exe, permitiendo especificar procesos, archivos locales o parámetros JSON.

```bash
UiRobot.exe execute --process <NombreDelProceso>
UiRobot.exe execute --file "C:\Ruta\Al\Archivo.xaml"
UiRobot.exe execute --process <NombreDelProceso> --input "{'param1':'valor1','param2':2}"
UiRobot.exe execute --process <NombreDelProceso> --folder CarpetaOrchestrator
```

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

### UiPath CLI - Ejecutar proceso

Source: https://docs.rocketbot.com/category/ayuda/tips?print=print-search

Comandos para ejecutar procesos de UiPath desde línea de comandos usando UiRobot.exe, incluyendo opciones para archivos locales, parámetros de entrada y carpetas de Orchestrator.

```APIDOC
## UiRobot.exe execute

### Description
Ejecuta un proceso de UiPath desde la línea de comandos sin necesidad de Orchestrator.

### Method
CLI

### Command
UiRobot.exe execute

### Parameters
- **--process** (string) - Requerido - Nombre del proceso a ejecutar.
- **--file** (string) - Opcional - Ruta a un archivo .xaml local.
- **--input** (string) - Opcional - Parámetros en formato JSON.
- **--folder** (string) - Opcional - Carpeta desde Orchestrator.

### Examples
```
UiRobot.exe execute --process <NombreDelProceso>
UiRobot.exe execute --file "C:\Ruta\Al\Archivo.xaml"
UiRobot.exe execute --process <NombreDelProceso> --input "{'param1':'valor1','param2':2}"
UiRobot.exe execute --process <NombreDelProceso> --folder CarpetaOrchestrator
```
```

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

### GET /api/v1/external/tables/:id

Source: https://docs.rocketbot.com/2026/07/27/nexus-edicion-de-aplicacion-app-overview?print=print

Retrieves a specific table by its ID.

```APIDOC
## GET /api/v1/external/tables/:id

### Description
Get a table by ID.

### Method
GET

### Endpoint
/api/v1/external/tables/:id

### Authentication
Requires `X-API-Key` header.

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the table.

### Response
#### Success Response (200)
- **table** (object) - The table object.

#### Response Example
```json
{
  "table": {}
}
```
```

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

### List Messages

Source: https://docs.rocketbot.com/2026/02/13/saturn-studio-microsoft-teams

Gets the message history of a given channel.

```APIDOC
## List Messages

### Description
Gets the message history of a given channel.

### Parameters
- **Credential** (string) - Required - Credencial de Microsoft necesaria para listar mensajes.
- **Teams** (string) - Required - Selecciona el equipo del cual listar los mensajes.
- **Channels** (string) - Required - Selecciona el canal del cual listar los mensajes.
- **Assign result to variable** (variable) - Required - Variable donde se almacenará el resultado. Ejemplo: [{"id": "F1AA1BDEBE2D6235!sb180ff3714ec4e22878e81b6b729bbac", "name": "File.xlsx", "webUrl": "https://onedrive.live.com/personal/f1aa1bdebe2d6235"}]

### Response
Returns a list of messages from the channel.
```

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

### Listar permisos de tesseract en Mac

Source: https://docs.rocketbot.com/2019/10/10/tips-virtualizacion?print=print

Comando para visualizar los permisos del archivo tesseract y verificar si tiene permisos de ejecución.

```bash
ls -l
```

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

### Get Tasks

Source: https://docs.rocketbot.com/2025/04/10/saturn-studio-aistudio

Obtiene la lista completa de tareas configuradas en AiStudio. Requiere una credencial válida y permite asignar el resultado a una variable.

```APIDOC
## Get Tasks

### Description
Obtiene la lista completa de tareas configuradas en AiStudio.

### Parameters
- **Credencial** (string) - Requerido - Credencial de AiStudio necesaria para obtener las tareas.
- **Asignar resultado a variable** (variable) - Opcional - Variable donde se almacenará el resultado. Ejemplo: {"tasksList":[{"id":"ef9f70q671982029b781","entity_id":45,"name":"VOICE - ef9f70q671982029b781","type":"VOICE","status":"RUNNING"},{"id":"2f0ca41w4a6h623e308c","entity_id":45,"name":"VOICE - 2f0ca41w4a6h623e308c","type":"VOICE","status":"RUNNING"}]}

### Response
#### Success Response
- **tasksList** (array) - Lista de tareas configuradas.
  - **id** (string) - Identificador de la tarea.
  - **entity_id** (number) - Identificador de la entidad.
  - **name** (string) - Nombre de la tarea.
  - **type** (string) - Tipo de tarea (ej. VOICE).
  - **status** (string) - Estado de la tarea (ej. RUNNING).

#### Response Example
{"tasksList":[{"id":"ef9f70q671982029b781","entity_id":45,"name":"VOICE - ef9f70q671982029b781","type":"VOICE","status":"RUNNING"},{"id":"2f0ca41w4a6h623e308c","entity_id":45,"name":"VOICE - 2f0ca41w4a6h623e308c","type":"VOICE","status":"RUNNING"}]}
```

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

### widget.startNewConversation()

Source: https://docs.rocketbot.com/2025/12/24/saturn-studio-chat-widget?print=print

Clears the current conversation and starts a new one.

```APIDOC
## widget.startNewConversation()

### Description
Clears the current conversation history and initiates a new conversation.

### Method
Method call

### Endpoint
widget.startNewConversation()

### Parameters
None

### Request Example
```javascript
widget.startNewConversation();
```

### Response
No return value.
```

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

### UiPath API: Ejecutar proceso

Source: https://docs.rocketbot.com/2025/04/11/ejecucion-de-automatizaciones-desde-linea-de-comandos-y-api?print=print

Solicitud POST para iniciar un trabajo en UiPath Orchestrator utilizando la Release Key obtenida previamente.

```http
POST /odata/Jobs/UiPath.Server.Configuration.OData.StartJobs
Authorization: Bearer <token>
{
  "startInfo": {
    "ReleaseKey": "<releaseKey>",
    "Strategy": "Specific",
    "RobotIds": [1234],
    "InputArguments": "{\"param\":\"value\"}"
  }
}
```

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

### Get queues of a form

Source: https://docs.rocketbot.com/2026/03/27/saturn-studio-xperience?print=print

Extracts the list of queues associated with a form.

```APIDOC
## Get queues of a form

### Description
Extracts the list of queues associated with a form.

### Parameters
- **Credential** (string) - Required - Credencial de Orquestador. Example: `orchestrator - Test`
- **Form ID** (string) - Required - Token del formulario del cual se desean las colas. Example: `VGJBQ9DBICYZ4CB`
- **Reverse list** (boolean) - Optional - Si se activa, ordena la lista de la más nueva a la más antigua. Example: `Check`
- **Assign result to a Variable** (string) - Required - Variable donde se almacenará la lista de colas. Example: `{queue_list}`
```

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

### Comando para mantener la sesión activa al desconectarse

Source: https://docs.rocketbot.com/2018/09/25/rpa-en-servidores-virtuales

Script de PowerShell ejecutado mediante un archivo .bat que utiliza tscon.exe para mover la sesión actual a la consola, evitando la pérdida de interfaz gráfica.

```batch
@powershell -NoProfile -ExecutionPolicy unrestricted -Command "$sessionid=((quser $env:USERNAME | select -Skip 1) -split '\s+')[2]; tscon $sessionid /dest:console" 2> UnlockErrors.log
```