browse-ai

Browse AI API

Server path: /browse-ai | Type: Application | PCID required: Yes

Tools

Tool	Description
browse_ai_create_bulk_run	Create a bulk run
browse_ai_create_robot_webhook	Create a robot webhook
browse_ai_delete_robot_webhook	Delete a robot webhook
browse_ai_get_robot	Get robot details
browse_ai_get_robot_task	Get task details
browse_ai_get_status	Get system status
browse_ai_list_all_tasks	List all tasks across robots
browse_ai_list_robot_tasks	List tasks for a robot
browse_ai_list_robot_webhooks	List robot webhooks
browse_ai_list_robots	List robots
browse_ai_run_robot_task	Run a robot task
browse_ai_update_robot_cookies	Update robot cookies

---

browse_ai_create_bulk_run

Create a bulk run

Parameters:

Parameter	Type	Required	Default	Description
robotId	string	Yes	—	The unique identifier of the robot.
inputParameters	object[]	Yes	—	List of input-parameter objects, one per task to run. Each object’s keys must match the robot’s expected inputs.
title	string	No	—	A human-readable title for this bulk run.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "robotId": {
      "type": "string",
      "description": "The unique identifier of the robot."
    },
    "inputParameters": {
      "type": "array",
      "items": {
        "type": "object"
      },
      "description": "List of input-parameter objects, one per task to run. Each object's keys must match the robot's expected inputs."
    },
    "title": {
      "type": "string",
      "description": "A human-readable title for this bulk run."
    }
  },
  "required": [
    "PCID",
    "robotId",
    "inputParameters"
  ]
}

---

browse_ai_create_robot_webhook

Create a robot webhook

Parameters:

Parameter	Type	Required	Default	Description
robotId	string	Yes	—	The unique identifier of the robot.
eventType	string	No	—	Event type that triggers the webhook (e.g. ‘task.finished’).
hookUrl	string	Yes	—	Public HTTPS URL that Browse AI will POST task results to.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "robotId": {
      "type": "string",
      "description": "The unique identifier of the robot."
    },
    "eventType": {
      "type": "string",
      "description": "Event type that triggers the webhook (e.g. 'task.finished').",
      "enum": [
        "task.finished",
        "task.successful",
        "task.failed",
        "monitor.created",
        "monitor.failed"
      ]
    },
    "hookUrl": {
      "type": "string",
      "description": "Public HTTPS URL that Browse AI will POST task results to."
    }
  },
  "required": [
    "PCID",
    "robotId",
    "hookUrl"
  ]
}

---

browse_ai_delete_robot_webhook

Delete a robot webhook

Parameters:

Parameter	Type	Required	Default	Description
robotId	string	Yes	—	The unique identifier of the robot.
webhookId	string	Yes	—	The unique identifier of the webhook to delete.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "robotId": {
      "type": "string",
      "description": "The unique identifier of the robot."
    },
    "webhookId": {
      "type": "string",
      "description": "The unique identifier of the webhook to delete."
    }
  },
  "required": [
    "PCID",
    "robotId",
    "webhookId"
  ]
}

---

browse_ai_get_robot

Get robot details

Parameters:

Parameter	Type	Required	Default	Description
robotId	string	Yes	—	The unique identifier of the robot.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "robotId": {
      "type": "string",
      "description": "The unique identifier of the robot."
    }
  },
  "required": [
    "PCID",
    "robotId"
  ]
}

---

browse_ai_get_robot_task

Get task details

Parameters:

Parameter	Type	Required	Default	Description
robotId	string	Yes	—	The unique identifier of the robot.
taskId	string	Yes	—	The unique identifier of the task.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "robotId": {
      "type": "string",
      "description": "The unique identifier of the robot."
    },
    "taskId": {
      "type": "string",
      "description": "The unique identifier of the task."
    }
  },
  "required": [
    "PCID",
    "robotId",
    "taskId"
  ]
}

---

browse_ai_get_status

Get system status

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    }
  },
  "required": [
    "PCID"
  ]
}

---

browse_ai_list_all_tasks

List all tasks across robots

Parameters:

Parameter	Type	Required	Default	Description
page	integer	No	—	Page number for pagination (1-indexed).
sort	string	No	—	Sort order. Use a field name with optional ’-’ prefix for descending (e.g. ‘-createdAt’).
status	string	No	—	Filter tasks by status.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "page": {
      "type": "integer",
      "description": "Page number for pagination (1-indexed)."
    },
    "sort": {
      "type": "string",
      "description": "Sort order. Use a field name with optional '-' prefix for descending (e.g. '-createdAt')."
    },
    "status": {
      "type": "string",
      "description": "Filter tasks by status.",
      "enum": [
        "successful",
        "failed",
        "in-progress"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

---

browse_ai_list_robot_tasks

List tasks for a robot

Parameters:

Parameter	Type	Required	Default	Description
robotId	string	Yes	—	The unique identifier of the robot.
page	integer	No	—	Page number for pagination (1-indexed).
sort	string	No	—	Sort order. Use a field name with optional ’-’ prefix for descending (e.g. ‘-createdAt’).
status	string	No	—	Filter tasks by status.
fromDate	integer	No	—	Filter tasks created at or after this Unix timestamp (milliseconds).
toDate	integer	No	—	Filter tasks created at or before this Unix timestamp (milliseconds).

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "robotId": {
      "type": "string",
      "description": "The unique identifier of the robot."
    },
    "page": {
      "type": "integer",
      "description": "Page number for pagination (1-indexed)."
    },
    "sort": {
      "type": "string",
      "description": "Sort order. Use a field name with optional '-' prefix for descending (e.g. '-createdAt')."
    },
    "status": {
      "type": "string",
      "description": "Filter tasks by status.",
      "enum": [
        "successful",
        "failed",
        "in-progress"
      ]
    },
    "fromDate": {
      "type": "integer",
      "description": "Filter tasks created at or after this Unix timestamp (milliseconds)."
    },
    "toDate": {
      "type": "integer",
      "description": "Filter tasks created at or before this Unix timestamp (milliseconds)."
    }
  },
  "required": [
    "PCID",
    "robotId"
  ]
}

---

browse_ai_list_robot_webhooks

List robot webhooks

Parameters:

Parameter	Type	Required	Default	Description
robotId	string	Yes	—	The unique identifier of the robot.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "robotId": {
      "type": "string",
      "description": "The unique identifier of the robot."
    }
  },
  "required": [
    "PCID",
    "robotId"
  ]
}

---

browse_ai_list_robots

List robots

Parameters:

Parameter	Type	Required	Default	Description
page	integer	No	—	Page number for pagination (1-indexed).

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "page": {
      "type": "integer",
      "description": "Page number for pagination (1-indexed)."
    }
  },
  "required": [
    "PCID"
  ]
}

---

browse_ai_run_robot_task

Run a robot task

Parameters:

Parameter	Type	Required	Default	Description
robotId	string	Yes	—	The unique identifier of the robot to run.
inputParameters	object	Yes	—	Robot-specific input parameters. Use getRobot to discover the required fields. Common keys include ‘originUrl’. Additional properties are allowed.
recordVideo	boolean	No	—	Whether to record a video of the run.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "robotId": {
      "type": "string",
      "description": "The unique identifier of the robot to run."
    },
    "inputParameters": {
      "type": "object",
      "description": "Robot-specific input parameters. Use getRobot to discover the required fields. Common keys include 'originUrl'. Additional properties are allowed."
    },
    "recordVideo": {
      "type": "boolean",
      "description": "Whether to record a video of the run."
    }
  },
  "required": [
    "PCID",
    "robotId",
    "inputParameters"
  ]
}

---

browse_ai_update_robot_cookies

Update robot cookies

Parameters:

Parameter	Type	Required	Default	Description
robotId	string	Yes	—	The unique identifier of the robot.
cookies	object[]	Yes	—	List of cookie objects to attach to this robot.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "robotId": {
      "type": "string",
      "description": "The unique identifier of the robot."
    },
    "cookies": {
      "type": "array",
      "items": {
        "type": "object"
      },
      "description": "List of cookie objects to attach to this robot."
    }
  },
  "required": [
    "PCID",
    "robotId",
    "cookies"
  ]
}