Built by Metorial, the integration platform for agentic AI.
Retrieve the status and progress of a bulk run. Returns the current state, counts of successful and failed tasks, and completion timestamp. Use this to monitor the progress of large-scale extraction operations.
List tasks for a given robot with optional filtering by status, date range, and bulk run. Supports pagination. Returns task IDs, statuses, extracted data, and metadata for each task.
List all webhooks configured for a specific robot. Returns the webhook IDs, destination URLs, and event types.
Remove a webhook from a robot. The webhook will stop receiving event notifications immediately.
Register a new webhook on a robot that fires when a specific event occurs. Supported event types: `taskFinished`, `taskFinishedSuccessfully`, `taskFinishedWithError`, `taskCapturedDataChanged`, `tableExportFinishedSuccessfully`.
Update the cookies associated with a robot. This is useful for maintaining authenticated sessions on target websites that require login. Provide the cookies as an array of cookie objects.
Retrieve the status and results of a specific task. When the task has completed successfully, the response includes extracted data in `capturedTexts` and any captured screenshots. Use this to check task progress or fetch scraped data after running a robot.
Submit a bulk run to process many pages in a single operation. Provide a list of input parameter sets (typically URLs) and a descriptive title. This is the recommended approach for large-scale data extraction instead of creating individual tasks.
Execute a web scraping robot on-demand by providing its ID and input parameters (typically an `originUrl`). The task runs asynchronously — the response includes the task ID and its initial status. Use **Get Task** to poll for results once the task completes.
Retrieve detailed information about a specific Browse AI robot by its ID. Returns the robot's name, creation date, and the input parameters it accepts including parameter names, types, and whether they are required.
Retrieve all configured web scraping robots in your Browse AI account. Returns each robot's ID, name, creation date, and the input parameters it accepts. Use this to discover available robots before running tasks.