Guide

Documentation

Complete reference for BrowserOps APIs, browser automation, and PlatPhorm Network integration.

API Reference

Complete REST API documentation and SDK

→ Journeys API → Runs API → Readiness API → Artifacts API

Database Schema

PostgreSQL schema and data models

→ Journeys Schema → Runs Schema → Artifacts Schema → Events Schema

Browser Automation

Playwright and browser journey execution

→ Journey Synthesis → Step Execution → Screenshot Capture → Accessibility Testing

Security & Auth

Public-safe reads and protected action boundary

→ PLATPHORM_API_KEY → Protected Run Actions → Public Read Surfaces → Audit Boundaries

Artifacts & Storage

Blob storage and artifact management

→ Upload Artifacts → Access Control → Versioning → CDN Delivery

Network Integration

PlatPhorm Network service integration

→ Network Graph Sync → Service Registry → Webhooks → Event Streaming → Claws Integration (Web Scraping)

Quick Start

Public Health

curl https://browserops.platphormnews.com/api/v1/health

Protected Run Action

curl -X POST \
  -H "Authorization: Bearer $PLATPHORM_API_KEY" \
  https://browserops.platphormnews.com/api/v1/journeys/browserops-homepage-smoke/run

Run API behavior

Run API controls open an action panel and never navigate directly to POST-only endpoints. GET on a run endpoint returns structured 405 JSON; trusted-domain browser execution uses a request key when provided, or the server-side Vercel PLATPHORM_API_KEY when no operator key is entered.

platphormctl browserops flow browserops-homepage-smoke --mode protected_browser_run
platphormctl site inspect browserops
platphormctl mcp validate browserops

OpenAPI / Swagger

Full OpenAPI 3.1 specification available at:

View OpenAPI Spec