$npx -y skills add catalystbyzoho/agent-skills --skill catalyst-smartbrowzCatalyst SmartBrowz — browser automation and document generation service. Includes Headless (connect to remote Chrome/Firefox with Puppeteer/Playwright/Selenium), Browser Logic (serverless functions for browser tasks in Java/Node.js), PDF & Screenshot (generate visual documents f
| 1 | ## Prerequisites |
| 2 | |
| 3 | Before using SmartBrowz, activate it once per project in the console: |
| 4 | > Console → your project → **SmartBrowz** (left sidebar) → click **"Start Exploring"** |
| 5 | |
| 6 | Skipping this step prevents access to Headless, Browser Logic, PDF & Screenshot, Templates, Browser Grid, and Dataverse components. |
| 7 | |
| 8 | **For Browser Logic functions:** Requires Catalyst CLI installation. Initialize and deploy Browser Logic functions via CLI (cannot be created directly in console, but can be uploaded). |
| 9 | |
| 10 | --- |
| 11 | |
| 12 | ## How It Works |
| 13 | |
| 14 | 1. **Multi-component service** — SmartBrowz offers 6 independent components in one unified platform: |
| 15 | - **Headless**: Connect to remote Chrome/Firefox in Catalyst cloud with automation libraries |
| 16 | - **Browser Logic**: Serverless functions (Java/Node.js) containing browser automation logic |
| 17 | - **PDF & Screenshot**: Generate visual documents programmatically |
| 18 | - **Templates**: Design and store templates for dynamic content |
| 19 | - **Browser Grid** (Early Access): Parallel headless browsers with auto-scaling |
| 20 | - **Dataverse**: Data scraping APIs |
| 21 | |
| 22 | 2. **Choose your workflow:** |
| 23 | - **Headless mode**: Copy console-provided endpoints and code snippets to connect with Puppeteer/Playwright/Selenium |
| 24 | - **Browser Logic**: Initialize via CLI, code in IDE, deploy to console — for persistent browser automation tasks |
| 25 | - **PDF & Screenshot**: Use console Playground, SDKs (Java/Node.js/Python), or API to generate documents |
| 26 | - **Browser Grid**: Configure node/browser count, connect via CDP/Webdriver endpoints, process requests in parallel |
| 27 | |
| 28 | 3. **Load `references/smartbrowz-basics.md`** — for component details, automation library setup, Browser Logic structure, PDF/Screenshot SDK usage, Browser Grid configurations, and troubleshooting |
| 29 | |
| 30 | 4. **SDK-first rule** — When writing implementation code, always prefer SDK methods over raw REST API calls: |
| 31 | - **Node.js**: `app.SmartBrowz()` → `smartbrowz.convertToPdf()`, `smartbrowz.generateFromTemplate()`, `app.SmartBrowz().browserGrid()` → `grid.getGrid()`, `grid.stopGrid()` |
| 32 | - **Python**: `app.smart_browz()` → `smart_browz.convert_to_pdf()`, `smart_browz.generate_from_template()`, `app.smart_browz().browser_grid()` → `grid.get_all_grid()` |
| 33 | - **Java**: `ZCSmartBrowz.getInstance()` → `smartBrowz.convertToPdf()`, `smartBrowz.generateFromTemplate()` |
| 34 | - Use REST API **only** when no SDK equivalent exists (e.g., checking `free_sessions` on Browser Grid live stats) |
| 35 | |
| 36 | 5. **Key concepts:** |
| 37 | - **Remote browsers run in Catalyst cloud** — not local. Endpoints are auto-generated by console. |
| 38 | - **No api-key in connection code** — Puppeteer/Playwright/Selenium connect using only the endpoint URL. The `api-key` is only used for Browser Grid REST API calls (e.g., live stats). |
| 39 | - **Chrome browser only** (currently) — Firefox support in Browser Grid (Early Access) |
| 40 | - **Browser Logic functions = Serverless function type** — created with CLI, not console UI |
| 41 | - **Browser Grid = auto-scaling** — nodes and browsers spawn on demand based on configuration |
| 42 | - **Code Recipes** available in console for testing automation library use cases |
| 43 | |
| 44 | 6. **Security note** — Any browser automation or web scraping is at your own risk. Only use on domains that permit such actions or with proper approval. |
| 45 | |
| 46 | ## Security Checklist |
| 47 | |
| 48 | - **API Key protection**: Endpoints for Headless and Browser Grid are secured with auto-generated API keys. Regenerate keys if compromised (note: this resets grid stats). |
| 49 | - **Browser Logic logs**: All function activity is logged in Console → DevOps → Logs. Review logs for debugging and security audits. |
| 50 | - **Browser Grid queue limits**: Selenium requests queue for 30 seconds, Puppeteer/Playwright for 5 minutes. After timeout, requests are killed. |
| 51 | - **Browser Grid alerts**: Monitor Dashboard for alerts (Browser Creation Rejected, 90% Disk Exhausted, 80% Memory/CPU Exhausted, Nodes Crashed). |
| 52 | - **Default storage**: Browser Grid nodes have 10GB disk limit. Monitor disk usage to prevent failures. |
| 53 | - **Rate considerations**: Browser automation can generate high network traffic. Be mindful of t |