### Example GET Request to Open Profile

Source: https://docs.hidemium.io/hidemium-4/i.-bat-dau-voi-hidemium/api-automation-v4/remote-profile/1.-open-profile

Demonstrates an example GET request to the /openProfile endpoint. This request includes a UUID, a command to set clipboard mode, window size and position, and proxy details. The command parameter can be replaced with other commands.

```HTTP
GET http://127.0.0.1:2222/openProfile?uuid=22387ee6-7386-4710-815c-d47d03a69f58&command=--hidemium-clipboard-mode=allow --window-position=500,500 --window-size=1280,800&proxy=HTTP|117.7.228.236|60001|E9Jr0ZzaPQD8|0vBZs1uroVnm
```

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

### Example GET Request for Campaigns

Source: https://docs.hidemium.io/hidemium-4/i.-bat-dau-voi-hidemium/api-automation-v4/campaign/get-campaign

Demonstrates how to make a GET request to the /automation/campaign endpoint to retrieve a list of campaigns. It specifies the URL with parameters for searching, pagination, and limiting results. No specific programming language is tied to this example.

```http
GET http://localhost:2222/automation/campaign?search=&page=1&limit=10
```

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

### List Version API Request Example

Source: https://docs.hidemium.io/hidemium-4/i.-bat-dau-voi-hidemium/api-automation-v4/get-profile/5.-list-version

This example demonstrates how to make a GET request to the /v2/browser/get-list-version endpoint to retrieve a list of available software versions. It specifies the method and URL for the request.

```http
GET http://127.0.0.1:2222/v2/browser/get-list-version
```

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

### Set execute permissions for Hidemium4 configuration directory

Source: https://docs.hidemium.io/hidemium-4/i.-bat-dau-voi-hidemium/installation-guide-for-hidemium4-on-macos

This command recursively sets execute permissions for the Hidemium4 configuration directory. It is typically used when re-installing Hidemium4 on a machine that previously had it installed. The user needs to replace 'ten_may' with their actual computer username.

```shell
chmod -R +x /Users/ten_may/.hidemium_4
```

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

### Example Close Profile API Request

Source: https://docs.hidemium.io/hidemium-4/i.-bat-dau-voi-hidemium/api-automation-v4/remote-profile/2.-close-profile

This snippet demonstrates an example GET request to the closeProfile API endpoint. It requires a 'uuid' parameter representing the profile to be closed. The example URL is for a local development environment.

```http
GET http://127.0.0.1:2222/closeProfile?uuid=992bd6f1-0a4c-40b2-88c0-d6ae54db7347
```

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

### List Version API Response Example

Source: https://docs.hidemium.io/hidemium-4/i.-bat-dau-voi-hidemium/api-automation-v4/get-profile/5.-list-version

This example shows the expected JSON response when querying the /v2/browser/get-list-version endpoint. The response is a dictionary where keys represent operating systems and values are lists of version strings.

```json
{
    "win": [
        "115.0.5790.32",
        "114.0.5735.61"
    ],
    "lin": [
        "115.0.5790.32",
        "114.0.5735.90"
    ],
    "android": [
        "115.0.5790.32",
        "114.0.5735.196"
    ],
    "mac": [
        "115.0.5790.3",
        "114.0.5735.90"
    ]
}
```

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

### Example Default Config Response

Source: https://docs.hidemium.io/hidemium-4/i.-bat-dau-voi-hidemium/api-automation-v4/get-profile/2.-list-config-default

This is an example JSON response from the Hidemium API's default configuration endpoint. It shows the structure of configuration objects, including their ID, name, default status, configuration details (OS, browser), and creation timestamp. This response is typically returned when requesting a list of default configurations.

```JSON
[
    {
        "id": 433,
        "name": "1",
        "isDefault": true,
        "config": {
            "os": [
                "win",
                "mac",
                "lin",
                "android"
            ],
            "browser": [
                "chrome"
            ],
            "name": "1",
            "id": 433,
            "StartUrl": null
        },
        "created_at": "2024-01-08T01:19:37.000000Z"
    },
    {
        "id": 427,
        "name": "3 browser",
        "isDefault": false,
        "config": {
            "browser": [
                "chrome",
                "edge",
                "opera"
            ],
            "name": "3 browser",
            "profileName": "fgh",
            "id": 427,
            "StartUrl": null
        },
        "created_at": "2024-01-06T04:49:52.000000Z"
    }
]
```

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

### Get Default Config List (Hidemium V4)

Source: https://docs.hidemium.io/hidemium-4/i.-bat-dau-voi-hidemium/api-automation-v4/get-profile/2.-list-config-default

This snippet demonstrates how to make a GET request to the Hidemium API to retrieve a list of default configurations. It supports pagination using 'page' and 'limit' parameters, and filtering by 'type' (create or order). The response is a JSON array of configuration objects.

```HTTP
GET http://127.0.0.1:2222/v2/default-config?page=1&limit=10
```

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

### Example Response for Opening Profile

Source: https://docs.hidemium.io/hidemium-4/i.-bat-dau-voi-hidemium/api-automation-v4/remote-profile/1.-open-profile

Shows a successful response after opening a profile. The response includes a status message, and data containing the remote port, the profile's file path, and the executable path for the browser.

```JSON
{
    "status": "successfully",
    "data": {
        "remote_port": 4000,
        "profile_path": "C:\\Users\\*****\\AppData\\Local\\Temp\\.hidemium\\99bed28d-7d71-432e-87c8-71d24926acb3",
        "execute_path": "C:\\Users\\*****\\.hidemium\\browser\\mulbrowser\\115.0.0.0_v6\\chrome.exe"
    }
}
```

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

### GET /v2/default-config

Source: https://docs.hidemium.io/hidemium-4/i.-bat-dau-voi-hidemium/api-automation-v4/get-profile/2.-list-config-default

Retrieves a list of default configurations. You can paginate the results and optionally filter by configuration type (create or order).

```APIDOC
## GET /v2/default-config

### Description
Retrieves a list of default configurations. Supports pagination and filtering by configuration type.

### Method
GET

### Endpoint
/v2/default-config

### Parameters
#### Query Parameters
- **page** (integer) - Optional - The page number for pagination. Defaults to 1.
- **limit** (integer) - Optional - The number of items to return per page. Defaults to 10.
- **type** (string) - Optional - Filters the results. Accepts 'create' for creation configurations or 'order' for purchase configurations. If omitted, both types are returned.

### Request Example
```json
{
  "example": "GET /v2/default-config?page=1&limit=10&type=create"
}
```

### Response
#### Success Response (200)
- **id** (integer) - The unique identifier of the configuration.
- **name** (string) - The name of the configuration.
- **isDefault** (boolean) - Indicates if this is a default configuration.
- **config** (object) - Contains the configuration details.
  - **os** (array) - List of supported operating systems.
  - **browser** (array) - List of supported browsers.
  - **name** (string) - The name of the configuration within the config object.
  - **id** (integer) - The ID within the config object.
  - **StartUrl** (string or null) - The starting URL, if applicable.
- **created_at** (string) - The timestamp when the configuration was created.

#### Response Example
```json
{
  "example": "[
    {
        "id": 433,
        "name": "1",
        "isDefault": true,
        "config": {
            "os": [
                "win",
                "mac",
                "lin",
                "android"
            ],
            "browser": [
                "chrome"
            ],
            "name": "1",
            "id": 433,
            "StartUrl": null
        },
        "created_at": "2024-01-08T01:19:37.000000Z"
    },
    {
        "id": 427,
        "name": "3 browser",
        "isDefault": false,
        "config": {
            "browser": [
                "chrome",
                "edge",
                "opera"
            ],
            "name": "3 browser",
            "profileName": "fgh",
            "id": 427,
            "StartUrl": null
        },
        "created_at": "2024-01-06T04:49:52.000000Z"
    }
]"
}
```
```

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

### Example Campaign Response Structure

Source: https://docs.hidemium.io/hidemium-4/i.-bat-dau-voi-hidemium/api-automation-v4/campaign/get-campaign

Illustrates the expected JSON structure for a successful response when requesting campaign data. The response contains a 'campaign' key, which is an array that will hold the campaign objects. This is a general JSON structure, not tied to a specific language.

```json
{
 "campaign":[
 //content
 ]
 }
```

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

### Example API Response for Listing Profiles (JSON)

Source: https://docs.hidemium.io/hidemium-4/i.-bat-dau-voi-hidemium/api-automation-v4/get-profile/1.-list-profile

This JSON structure represents a successful response from the list profiles API. It includes a 'data' object containing profile information, 'links' for pagination, and 'meta' for pagination details such as current page and total items. The 'content' array within 'data' holds the details of each profile.

```json
"data": {
        "type": "success",
        "title": "Load successfully",
        "content": [
            {
                "uuid": "992bd6f1-0a4c-40b2-88c0-d6ae54db7347",
                "directory": "2023/05/15",
                "file_name": "e332938226517443e5ca72b5d269a0a6.zip",
                "can_be_running": true,
                "proxy": "",
                "created_at": "2023-05-15T07:28:07.000000Z",
                "created_at_diff": "43 minutes ago",
                "id": 20165,
                "folder_id": 532,
                "check_open": 1,
                "name": "15 - 5",
                "version": 112,
                "browser_type": "hidemium",
                "os": "mac",
                "note": "",
                "last_open": "2023-05-15 14:30:53",
                "last_open_diff": "41 minutes ago",
                "transfer": "",
                "source_version": null,
                "shares_role": false,
                "shared_uuid": "",
                "status": null,
                "status_chil": 0,
                "tags": [],
                "status_id": null,
                "listing": null
            }
        ]
    },
    "links": {
        "first": "https://v2-api.multibrowser.io/v1/browser/list?page=1",
        "last": "https://v2-api.multibrowser.io/v1/browser/list?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "https://v2-api.multibrowser.io/v1/browser/list?page=1",
        "per_page": "10",
        "to": 1,
        "total": 1
    }
```

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

### List Tags API Request Example

Source: https://docs.hidemium.io/hidemium-4/i.-bat-dau-voi-hidemium/api-automation-v4/get-profile/4.-list-tag

This snippet demonstrates how to make a GET request to the /v2/tag endpoint to retrieve a list of tags. The 'is_local' parameter can be used to filter results for local profiles.

```http
GET http://127.0.0.1:2222/v2/tag?is_local=true
```

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

### GET /automation/campaign

Source: https://docs.hidemium.io/hidemium-4/i.-bat-dau-voi-hidemium/api-automation-v4/campaign/get-campaign

Retrieves a list of campaigns. Supports filtering by name and pagination.

```APIDOC
## GET /automation/campaign

### Description
Returns a list of campaigns. The `search` parameter can be used to filter campaigns by name. If `search` is left blank, all campaigns will be returned. Pagination is supported using `page` and `limit` parameters.

### Method
GET

### Endpoint
`/automation/campaign`

### Parameters
#### Query Parameters
- **search** (string) - Optional - Enter the name of the campaign you want to get the ID from, if left blank it will display all.
- **page** (integer) - Optional - The page number for pagination. Defaults to 1.
- **limit** (integer) - Optional - The number of campaigns to return per page. Defaults to 10.

### Request Example
```json
{
  "example": "GET /automation/campaign?search=MyCampaign&page=1&limit=10"
}
```

### Response
#### Success Response (200)
- **campaign** (array) - A list of campaign objects.

#### Response Example
```json
{
  "campaign": [
    // campaign objects would be listed here
  ]
}
```
```

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

### GET /v1/folder/list

Source: https://docs.hidemium.io/hidemium-4/i.-bat-dau-voi-hidemium/api-automation-v4/get-profile/7.-get-list-folder

Retrieves a list of folders. You can filter by local or cloud profiles and specify pagination parameters.

```APIDOC
## GET /v1/folder/list

### Description
Returns a list of your folders. You can specify whether to show local or cloud profiles and control pagination.

### Method
GET

### Endpoint
/v1/folder/list

### Parameters
#### Query Parameters
- **is_local** (boolean) - Optional - `false`: Show cloud profiles, `true`: Show local profiles
- **page** (integer) - Optional - The page number for pagination. Defaults to 1.
- **limit** (integer) - Optional - The number of items to return per page. Defaults to 10.

### Request Example
```json
{
  "example": "GET /v1/folder/list?is_local=false&page=1&limit=10"
}
```

### Response
#### Success Response (200)
- **id** (integer) - The unique identifier for the folder.
- **uuid** (string) - The universally unique identifier for the folder.
- **name** (string) - The name of the folder.
- **total_browser** (integer) - The total number of browsers within the folder.
- **created_at** (string) - The timestamp when the folder was created (ISO 8601 format).
- **created_at_diff** (string) - A human-readable representation of the time difference since creation.

#### Response Example
```json
[
    {
        "id": 598,
        "uuid": "9a7dc6b9-b088-49c4-9030-e28298f9bfa1",
        "name": "Facebook",
        "total_browser": 10,
        "created_at": "2023-10-30T07:12:36.000000Z",
        "created_at_diff": "18 hours ago"
    },
    {
        "id": 602,
        "uuid": "9a7f52ac-e791-4915-9912-d1c93c8c2556",
        "name": "Youtube",
        "total_browser": 10,
        "created_at": "2023-10-31T01:39:45.000000Z",
        "created_at_diff": "1 minute ago"
    }
]
```
```

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

### GET /automation/schedule

Source: https://docs.hidemium.io/hidemium-4/i.-bat-dau-voi-hidemium/api-automation-v4/campaign/get-schedule

Retrieves a list of schedules for a given campaign. Supports pagination.

```APIDOC
## GET /automation/schedule

### Description
Returns a list of schedules in a campaign. This endpoint supports pagination using `page` and `limit` query parameters.

### Method
GET

### Endpoint
/automation/schedule

### Parameters
#### Query Parameters
- **campaign_id** (integer) - Required - The ID of the campaign to retrieve schedules for.
- **page** (integer) - Optional - The page number for pagination. Defaults to 1.
- **limit** (integer) - Optional - The number of schedules to return per page. Defaults to 10.

### Request Example
```json
{
  "example": "GET http://localhost:2222/automation/schedule?campaign_id=25&page=1&limit=10"
}
```

### Response
#### Success Response (200)
- **schedule** (array) - A list of schedule objects within the campaign.

#### Response Example
```json
{
  "schedule": [
    // schedule objects
  ]
}
```
```

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

### List Scripts API Request (Hidemium V4)

Source: https://docs.hidemium.io/hidemium-4/i.-bat-dau-voi-hidemium/api-automation-v4/automation/list-scripts

This snippet shows the GET request method and URL to retrieve a list of scripts. It demonstrates pagination using 'page' and 'limit' query parameters.

```HTTP
GET http://127.0.0.1:2222/v2/automation/script?page=1&limit=10
```

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

### GET /v2/browser/get-list-version

Source: https://docs.hidemium.io/hidemium-4/i.-bat-dau-voi-hidemium/api-automation-v4/get-profile/5.-list-version

Retrieves a list of tag versions for various operating systems including Windows, Linux, Android, and macOS.

```APIDOC
## GET /v2/browser/get-list-version

### Description
Retrieves a list of tag versions for various operating systems.

### Method
GET

### Endpoint
/v2/browser/get-list-version

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **win** (array[string]) - List of Windows versions.
- **lin** (array[string]) - List of Linux versions.
- **android** (array[string]) - List of Android versions.
- **mac** (array[string]) - List of macOS versions.

#### Response Example
```json
{
    "win": [
        "115.0.5790.32",
        "114.0.5735.61"
    ],
    "lin": [
        "115.0.5790.32",
        "114.0.5735.90"
    ],
    "android": [
        "115.0.5790.32",
        "114.0.5735.196"
    ],
    "mac": [
        "115.0.5790.3",
        "114.0.5735.90"
    ]
}
```
```

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

### Get Cookies

Source: https://docs.hidemium.io/hidemium-4/iv.-tu-dong-hoa-automation-and-ai/automation-foundation-automation-co-ban/data/get-cookies

Use the Get cookies node to obtain user activity and cookie information, which can then be saved to a variable.

```APIDOC
## GET /cookies

### Description
Retrieves cookie information and user usage activity for a specified domain and saves it to a variable.

### Method
GET

### Endpoint
/cookies

### Parameters
#### Query Parameters
- **Domain** (string) - Optional - The domain of the website for which to retrieve cookies. If left empty, all browser cookies will be retrieved.
- **Output Variable** (string) - Required - The name of the variable where the extracted cookies will be saved.

### Request Example
```json
{
  "Domain": "example.com",
  "Output Variable": "userCookies"
}
```

### Response
#### Success Response (200)
- **cookies** (object) - An object containing the retrieved cookies.

#### Response Example
```json
{
  "cookies": {
    "session_id": "abc123xyz789",
    "preferences": "theme=dark&lang=en"
  }
}
```
```

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

### GET /v2/automation/script

Source: https://docs.hidemium.io/hidemium-4/i.-bat-dau-voi-hidemium/api-automation-v4/automation/list-scripts

Retrieves a paginated list of automation scripts (workflows). You can control the page number and the number of items per page.

```APIDOC
## GET /v2/automation/script

### Description
Returns a list of scripts (workflows) with pagination support.

### Method
GET

### Endpoint
/v2/automation/script

### Query Parameters
- **page** (integer) - Optional - The page number to retrieve.
- **limit** (integer) - Optional - The number of items to return per page.

### Request Example
```json
{
  "example": "GET /v2/automation/script?page=1&limit=10"
}
```

### Response
#### Success Response (200)
- **data** (object) - Contains the response status and content.
  - **type** (string) - The status of the request (e.g., "success").
  - **title** (string) - A brief title for the response (e.g., "Request successfully.").
  - **content** (array) - An array containing the script objects.

#### Response Example
```json
{
  "data": {
    "type": "success",
    "title": "Request successfully.",
    "content": [
      //content information
    ]
  }
}
```
```

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

### Example Response for Schedule Update

Source: https://docs.hidemium.io/hidemium-4/i.-bat-dau-voi-hidemium/api-automation-v4/campaign/update-schedule-status

This snippet shows a typical successful response after updating a schedule's status. It confirms the update operation with a success message.

```JSON
{
    "message": "Update schedule success!!!"
}
```

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

### Schedule Creation Response - JSON

Source: https://docs.hidemium.io/hidemium-4/i.-bat-dau-voi-hidemium/api-automation-v4/campaign/create-schedule

This JSON object represents the successful creation of a campaign schedule. It includes the assigned campaign ID, schedule details such as start time and execution frequency, and status information. The 'id' field is the unique identifier for the created schedule.

```json
{
    "campaign_id": 68,
    "end_time": null,
    "execute_day": null,
    "execute_time": null,
    "execution_frequency": 1,
    "interval_time": null,
    "name": "Run Campaign - Reg Etsy Bằng Gmail",
    "task_type": 2,
    "start_time": "2024-12-17 10:25:37",
    "user_uuid": "73452ab4-bed5-452d-bbf1-7caf441ff7c5",
    "status": 1,
    "total_profile_pending": 0,
    "total_profile_running": 0,
    "total_profile_success": 0,
    "total_profile_error": 0,
    "id": 77,
    "created_at": "2024-12-17T09:42:28.000Z",
    "updated_at": "2024-12-17T09:42:28.000Z"
}
```

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

### Example Close Profile API Response

Source: https://docs.hidemium.io/hidemium-4/i.-bat-dau-voi-hidemium/api-automation-v4/remote-profile/2.-close-profile

This snippet shows a typical JSON response when the closeProfile API successfully closes a profile. It indicates a boolean 'result' of true upon successful operation.

```json
{
    "result": true
}
```

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

### Example API Response for Profile Check

Source: https://docs.hidemium.io/hidemium-4/i.-bat-dau-voi-hidemium/api-automation-v4/remote-profile/3.-checking

This JSON object represents the response from the API when checking a profile's status. A 'status' of 'true' indicates the profile is open, while 'false' indicates it is closed.

```json
{
    "status": true
}
```

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

### POST /automation/campaign

Source: https://docs.hidemium.io/hidemium-4/i.-bat-dau-voi-hidemium/api-automation-v4/campaign/create-campaign

Creates a new campaign with specified settings. You can configure automation processes, delays, screen arrangements, and more.

```APIDOC
## POST /automation/campaign

### Description
Creates a new campaign with specified settings. You can configure automation processes, delays, screen arrangements, and more.

### Method
POST

### Endpoint
/automation/campaign

### Parameters
#### Request Body
- **script_id** (integer) - Required - Use List script API to get script ID.
- **name** (string) - Required - The name of the campaign.
- **script_name** (string) - Required - The name of the script associated with the campaign.
- **script_key** (string) - Required - The key of the script associated with the campaign. Use List script API to get the key.
- **settings** (object) - Optional - Configuration settings for the campaign.
  - **automationProcess** (integer) - The automation process level.
  - **delayOpen** (integer) - Delay in seconds before opening.
  - **isScreenArrangement** (boolean) - Whether to arrange the screen. true or false.
  - **arrangementLayoutCol** (integer) - Number of columns for screen arrangement.
  - **arrangementLayoutRow** (integer) - Number of rows for screen arrangement.
  - **autoScaleScreen** (boolean) - Whether to auto-scale the screen. true or false.
  - **screenScalePercent** (integer) - The percentage to scale the screen.
  - **isSetWindowSize** (boolean) - Whether to set a specific window size. true or false.
  - **screenSize** (string) - The screen size in 'widthxheight' format.
  - **profilePerWorker** (integer) - Number of profiles per worker.
  - **writeLogs** (boolean) - Whether to write logs. true or false.
  - **isEnableStealthPlugin** (boolean) - Whether to enable the stealth plugin. true or false.
  - **isNotOverlapProfile** (boolean) - Whether to prevent profile overlap. true or false.
  - **closeProfileOnComplete** (boolean) - Whether to close the profile upon completion. true or false.

### Request Example
```json
{
    "script_id": 31539,
    "name": "Campaign - Reg Etsy Bằng Gmail",
    "script_name": "Reg Etsy Bằng Gmail",
    "script_key": "2pF5e8h7290724084332",
    "settings": {
        "automationProcess": 10,
        "delayOpen": 2,
        "isScreenArrangement": true,
        "arrangementLayoutCol": 2,
        "arrangementLayoutRow": 3,
        "autoScaleScreen": true,
        "screenScalePercent": 25,
        "isSetWindowSize": false,
        "screenSize": "1280x1030",
        "profilePerWorker": 10,
        "writeLogs": true,
        "isEnableStealthPlugin": false,
        "isNotOverlapProfile": false,
        "closeProfileOnComplete": true
    }
}
```

### Response
#### Success Response (200)
- **content** (object) - Description of the response content (details not provided in the input).

#### Response Example
```json
{
    "content": "//content"
}
```
```

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

### Remove extended attributes from Hidemium4 application

Source: https://docs.hidemium.io/hidemium-4/i.-bat-dau-voi-hidemium/installation-guide-for-hidemium4-on-macos

This command removes extended attributes from the Hidemium4 application bundle. It is often required on macOS to allow applications downloaded from the internet to run without Gatekeeper warnings. This command is executed in the Terminal.

```shell
xattr -cr /Applications/Hidemium4.app
```

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

### GET Request to List Status Profiles

Source: https://docs.hidemium.io/hidemium-4/i.-bat-dau-voi-hidemium/api-automation-v4/get-profile/3.-list-status

This snippet demonstrates how to make a GET request to the status-profile endpoint. It shows the URL structure and the optional 'is_local' parameter for filtering results. The response is a JSON array of status objects.

```http
GET http://127.0.0.1:2222/v2/status-profile?is_local=true
```

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

### Proxy Management API

Source: https://docs.hidemium.io/hidemium-4/i.-bat-dau-voi-hidemium

APIs for managing proxy settings and updates.

```APIDOC
## POST /api/automation/v4/proxy/update

### Description
Updates the proxy configuration.

### Method
POST

### Endpoint
/api/automation/v4/proxy/update

### Parameters
#### Request Body
- **profile_id** (string) - Required - The ID of the profile to update.
- **proxy** (object) - Required - The new proxy configuration.
  - **type** (string) - Required - The type of proxy (e.g., HTTP, SOCKS5).
  - **host** (string) - Required - The proxy host address.
  - **port** (integer) - Required - The proxy port number.
  - **username** (string) - Optional - The username for proxy authentication.
  - **password** (string) - Optional - The password for proxy authentication.

### Request Example
```json
{
  "profile_id": "example_profile_id",
  "proxy": {
    "type": "HTTP",
    "host": "192.168.1.1",
    "port": 8080,
    "username": "user",
    "password": "password"
  }
}
```

### Response
#### Success Response (200)
- **message** (string) - Success message.

#### Response Example
```json
{
  "message": "Proxy updated successfully."
}
```
```

```APIDOC
## POST /api/automation/v4/profile/proxy/update

### Description
Updates the proxy settings for a specific profile within a campaign.

### Method
POST

### Endpoint
/api/automation/v4/profile/proxy/update

### Parameters
#### Request Body
- **profile_id** (string) - Required - The ID of the profile.
- **campaign_id** (string) - Required - The ID of the campaign.
- **proxy** (object) - Required - The new proxy configuration.
  - **type** (string) - Required - The type of proxy (e.g., HTTP, SOCKS5).
  - **host** (string) - Required - The proxy host address.
  - **port** (integer) - Required - The proxy port number.
  - **username** (string) - Optional - The username for proxy authentication.
  - **password** (string) - Optional - The password for proxy authentication.

### Request Example
```json
{
  "profile_id": "example_profile_id",
  "campaign_id": "example_campaign_id",
  "proxy": {
    "type": "SOCKS5",
    "host": "10.0.0.1",
    "port": 1080,
    "username": "proxy_user",
    "password": "proxy_pass"
  }
}
```

### Response
#### Success Response (200)
- **message** (string) - Success message.

#### Response Example
```json
{
  "message": "Profile proxy updated successfully."
}
```
```

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

### POST /create-profile-by-default

Source: https://docs.hidemium.io/hidemium-4/i.-bat-dau-voi-hidemium/api-automation-v4/interact-profile/1.-create-profile-by-default

Creates a user profile using the default configuration. The API has a rate limit of 50 requests per minute.

```APIDOC
## POST /create-profile-by-default

### Description
Creates a user profile using the default configuration. The API has a rate limit of 50 requests per minute. Exceeding this limit may result in temporary blocking.

### Method
POST

### Endpoint
`http://127.0.0.1:2222/create-profile-by-default`

### Query Parameters
- **is_local** (boolean) - Optional - Specifies if the profile creation is local.

### Request Body
- **defaultConfigId** (integer) - Required - The ID of the default configuration to use for profile creation.

### Request Example
```json
{
    "defaultConfigId": 576
}
```

### Response
#### Success Response (200)
- **type** (string) - Indicates the status of the operation, e.g., "success".
- **title** (string) - A message describing the outcome of the operation, e.g., "Create successfully.".
- **content** (object) - Contains information related to the created profile.

#### Response Example
```json
{
    "type": "success",
    "title": "Create successfully.",
    "content": {
       //content information 
    }
}
```
```

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

### POST /automation/schedule

Source: https://docs.hidemium.io/hidemium-4/i.-bat-dau-voi-hidemium/api-automation-v4/campaign/create-schedule

Creates a schedule for an existing campaign. This endpoint allows you to define when and how a campaign should be executed.

```APIDOC
## POST /automation/schedule

### Description
Creates a schedule for an existing campaign. This endpoint allows you to define when and how a campaign should be executed.

### Method
POST

### Endpoint
http://localhost:2222/automation/schedule

### Parameters
#### Request Body
- **name** (string) - Required - The name of the schedule.
- **campaign_id** (integer) - Required - The ID of the campaign to schedule.
- **execution_frequency** (integer) - Required - The frequency of execution (1: Once, 2: Interval, 3: Daily, 4: Weekly, 5: Monthly).
- **interval_time** (integer) - Optional - The interval in minutes for 'Interval' frequency.
- **execute_time** (string) - Optional - The time of execution for 'Daily', 'Weekly', 'Monthly' frequencies (e.g., "10:59").
- **execute_day** (integer or string) - Optional - The day of the week (0-6 for Sunday-Saturday) or date of the month (1-31) for 'Weekly' or 'Monthly' frequencies.
- **start_time** (string) - Required - The start date and time for the schedule (e.g., "2024-12-17 10:25:37").
- **end_time** (string) - Optional - The end date and time for the schedule.
- **task_type** (integer) - Required - The type of task (e.g., 2 for Fixed).
- **isRunning** (boolean) - Required - Indicates if the schedule is currently running.

### Request Example
```json
{
    "name": "Run Campaign - Reg Etsy Bằng Gmail",
    "campaign_id": 25,
    "execution_frequency": 1,
    "start_time": "2024-12-17 10:25:37",
    "task_type": 2,
    "isRunning": false
}
```

### Response
#### Success Response (200)
- **campaign_id** (integer) - The ID of the campaign.
- **end_time** (string or null) - The end time of the schedule.
- **execute_day** (integer or null) - The day of execution.
- **execute_time** (string or null) - The time of execution.
- **execution_frequency** (integer) - The execution frequency.
- **interval_time** (integer or null) - The interval time.
- **name** (string) - The name of the schedule.
- **task_type** (integer) - The task type.
- **start_time** (string) - The start time of the schedule.
- **user_uuid** (string) - The user's UUID.
- **status** (integer) - The status of the schedule.
- **total_profile_pending** (integer) - Total pending profiles.
- **total_profile_running** (integer) - Total running profiles.
- **total_profile_success** (integer) - Total successful profiles.
- **total_profile_error** (integer) - Total error profiles.
- **id** (integer) - The unique ID of the created schedule.
- **created_at** (string) - The timestamp when the schedule was created.
- **updated_at** (string) - The timestamp when the schedule was last updated.

#### Response Example
```json
{
    "campaign_id": 68,
    "end_time": null,
    "execute_day": null,
    "execute_time": null,
    "execution_frequency": 1,
    "interval_time": null,
    "name": "Run Campaign - Reg Etsy Bằng Gmail",
    "task_type": 2,
    "start_time": "2024-12-17 10:25:37",
    "user_uuid": "73452ab4-bed5-452d-bbf1-7caf441ff7c5",
    "status": 1,
    "total_profile_pending": 0,
    "total_profile_running": 0,
    "total_profile_success": 0,
    "total_profile_error": 0,
    "id": 77,
    "created_at": "2024-12-17T09:42:28.000Z",
    "updated_at": "2024-12-17T09:42:28.000Z"
}
```
```

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

### Campaign Management API

Source: https://docs.hidemium.io/hidemium-4/i.-bat-dau-voi-hidemium

APIs for creating, managing, and retrieving campaign data.

```APIDOC
## GET /api/automation/v4/campaign/get

### Description
Retrieves details of a specific campaign.

### Method
GET

### Endpoint
/api/automation/v4/campaign/get

### Parameters
#### Query Parameters
- **campaign_id** (string) - Required - The ID of the campaign to retrieve.

### Request Example
```json
{ } // No request body, use query parameters
```

### Response
#### Success Response (200)
- **campaign_details** (object) - Details of the campaign.

#### Response Example
```json
{
  "campaign_details": {
    "id": "cmp_abc",
    "name": "Summer Sale",
    "status": "Active"
  }
}
```
```

```APIDOC
## POST /api/automation/v4/campaign/create

### Description
Creates a new campaign.

### Method
POST

### Endpoint
/api/automation/v4/campaign/create

### Parameters
#### Request Body
- **name** (string) - Required - The name of the new campaign.
- **script_id** (string) - Required - The ID of the script to associate with the campaign.

### Request Example
```json
{
  "name": "New Product Launch",
  "script_id": "script_xyz"
}
```

### Response
#### Success Response (200)
- **campaign_id** (string) - The ID of the newly created campaign.

#### Response Example
```json
{
  "campaign_id": "cmp_def"
}
```
```

```APIDOC
## POST /api/automation/v4/campaign/schedule/create

### Description
Creates a schedule for a campaign.

### Method
POST

### Endpoint
/api/automation/v4/campaign/schedule/create

### Parameters
#### Request Body
- **campaign_id** (string) - Required - The ID of the campaign.
- **schedule_time** (string) - Required - The time to run the schedule (ISO 8601 format).

### Request Example
```json
{
  "campaign_id": "cmp_ghi",
  "schedule_time": "2023-10-27T10:00:00Z"
}
```

### Response
#### Success Response (200)
- **schedule_id** (string) - The ID of the newly created schedule.

#### Response Example
```json
{
  "schedule_id": "sch_123"
}
```
```

```APIDOC
## GET /api/automation/v4/campaign/schedule/get

### Description
Retrieves schedule information for a campaign.

### Method
GET

### Endpoint
/api/automation/v4/campaign/schedule/get

### Parameters
#### Query Parameters
- **schedule_id** (string) - Required - The ID of the schedule to retrieve.

### Request Example
```json
{ } // No request body, use query parameters
```

### Response
#### Success Response (200)
- **schedule_details** (object) - Details of the schedule.

#### Response Example
```json
{
  "schedule_details": {
    "id": "sch_456",
    "campaign_id": "cmp_jkl",
    "scheduled_at": "2023-10-27T10:00:00Z",
    "status": "Pending"
  }
}
```
```

```APIDOC
## POST /api/automation/v4/campaign/schedule/update_status

### Description
Updates the status of a campaign schedule.

### Method
POST

### Endpoint
/api/automation/v4/campaign/schedule/update_status

### Parameters
#### Request Body
- **schedule_id** (string) - Required - The ID of the schedule.
- **status** (string) - Required - The new status (e.g., 'Active', 'Paused', 'Completed').

### Request Example
```json
{
  "schedule_id": "sch_789",
  "status": "Paused"
}
```

### Response
#### Success Response (200)
- **message** (string) - Success message.

#### Response Example
```json
{
  "message": "Schedule status updated successfully."
}
```
```

```APIDOC
## DELETE /api/automation/v4/campaign/schedule/delete

### Description
Deletes a campaign schedule.

### Method
DELETE

### Endpoint
/api/automation/v4/campaign/schedule/delete

### Parameters
#### Query Parameters
- **schedule_id** (string) - Required - The ID of the schedule to delete.

### Request Example
```json
{ } // No request body, use query parameters
```

### Response
#### Success Response (200)
- **message** (string) - Success message.

#### Response Example
```json
{
  "message": "Schedule deleted successfully."
}
```
```

```APIDOC
## POST /api/automation/v4/campaign/profile/add

### Description
Adds a profile to a campaign.

### Method
POST

### Endpoint
/api/automation/v4/campaign/profile/add

### Parameters
#### Request Body
- **campaign_id** (string) - Required - The ID of the campaign.
- **profile_id** (string) - Required - The ID of the profile to add.

### Request Example
```json
{
  "campaign_id": "cmp_mno",
  "profile_id": "prof_pqr"
}
```

### Response
#### Success Response (200)
- **message** (string) - Success message.

#### Response Example
```json
{
  "message": "Profile added to campaign successfully."
}
```
```

```APIDOC
## POST /api/automation/v4/campaign/input_variable/update

### Description
Updates an input variable for a campaign.

### Method
POST

### Endpoint
/api/automation/v4/campaign/input_variable/update

### Parameters
#### Request Body
- **campaign_id** (string) - Required - The ID of the campaign.
- **variable_name** (string) - Required - The name of the input variable.
- **variable_value** (string) - Required - The new value for the input variable.

### Request Example
```json
{
  "campaign_id": "cmp_stu",
  "variable_name": "target_url",
  "variable_value": "https://example.com"
}
```

### Response
#### Success Response (200)
- **message** (string) - Success message.

#### Response Example
```json
{
  "message": "Campaign input variable updated successfully."
}
```
```

```APIDOC
## DELETE /api/automation/v4/campaign/delete

### Description
Deletes a campaign.

### Method
DELETE

### Endpoint
/api/automation/v4/campaign/delete

### Parameters
#### Query Parameters
- **campaign_id** (string) - Required - The ID of the campaign to delete.

### Request Example
```json
{ } // No request body, use query parameters
```

### Response
#### Success Response (200)
- **message** (string) - Success message.

#### Response Example
```json
{
  "message": "Campaign deleted successfully."
}
```
```

```APIDOC
## DELETE /api/automation/v4/campaign/profile/delete_all

### Description
Deletes all profiles associated with a campaign. This API is enabled on version 4.0.24-1712+.

### Method
DELETE

### Endpoint
/api/automation/v4/campaign/profile/delete_all

### Parameters
#### Query Parameters
- **campaign_id** (string) - Required - The ID of the campaign from which to remove all profiles.

### Request Example
```json
{ } // No request body, use query parameters
```

### Response
#### Success Response (200)
- **message** (string) - Success message.

#### Response Example
```json
{
  "message": "All profiles deleted from the campaign successfully."
}
```
```

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

### Open Profile API

Source: https://docs.hidemium.io/hidemium-4/i.-bat-dau-voi-hidemium/api-automation-v4/remote-profile/1.-open-profile

This API endpoint allows you to open a profile by providing its UUID. It also supports optional parameters like 'command' and 'proxy'.

```APIDOC
## GET /openProfile

### Description
Returns an open profile based on the provided UUID.

### Method
GET

### Endpoint
/openProfile

### Parameters
#### Query Parameters
- **uuid** (string) - Required - UUID of the profile to open.
- **command** (string) - Optional - A command to execute when opening the profile. You can replace with another cmd.
- **proxy** (string) - Optional - Proxy details to use for the profile. Format: `HTTP|IP|PORT|USER|PASSWORD`. Supported types: HTTP, SOCKS5, SOCKS4, SSH. Type must be uppercase.

### Request Example
```
GET /openProfile?uuid=22387ee6-7386-4710-815c-d47d03a69f58&command=--window-position=500,500 --window-size=1280,800&proxy=HTTP|117.7.228.236|60001|E9Jr0ZzaPQD8|0vBZs1uroVnm
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the operation (e.g., "successfully").
- **data** (object) - Contains details about the opened profile.
  - **remote_port** (integer) - The remote port associated with the profile.
  - **profile_path** (string) - The file path to the profile directory.
  - **execute_path** (string) - The path to the browser executable.

#### Response Example
```json
{
    "status": "successfully",
    "data": {
        "remote_port": 4000,
        "profile_path": "C:\\Users\\*****\\AppData\\Local\\Temp\\.hidemium\\99bed28d-7d71-432e-87c8-71d24926acb3",
        "execute_path": "C:\\Users\\*****\\.hidemium\\browser\\mulbrowser\\115.0.0.0_v6\\chrome.exe"
    }
}
```
```