Rocketbot

https://docs.rocketbot.com/
Admin
Rocketbot is a robotic process automation (RPA) platform designed to build, execute, and orchestrate...
Tokens:569,467
Snippets:4,671
Trust Score:9.6
Update:4 days ago
Show doc for...
Tokens:
Raw
### 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()
```

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

### 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
```

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

### 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.
```

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

### 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
        },

    ]
}
```

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

### 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}}]}
```

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

### 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=="
    }
}
```

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

### 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}`
```

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

### 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.
```

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

### 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 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.
```

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

### 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 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()
```
Tokens:
Raw