Skip to content
Browserberg Browserberg

Browserberg API reference

Every v1 endpoint in one section: sessions, verbs, tasks, workflows, triggers, credentials, pools, the audit log, error codes and hard limits.

How to use this reference

Each page here covers one resource family end to end: the endpoints, the request bodies field by field, and the response fields worth branching on. If you are new, the quickstart is a faster first hour; come back when you need exact shapes. Failures share a single envelope across all endpoints — see Errors and retries — and the enforced numbers live in Limits.

All pages in this section

  1. 1

    Sessions API reference

    Create, inspect, extend and release browser sessions over HTTP: the full create body, the two keep-alive clamps and every field on the session record.

  2. 2

    Session verbs API reference

    Request and response shapes for the three verb endpoints on a session: observe candidates, act steps with withheld refusals, and extract schemas.

  3. 3

    Tasks API reference

    Start a hosted agent run inside a session and poll it to a terminal state: request options, TaskRun fields and the separate reviewer verdict.

  4. 4

    Workflows API reference

    Publish immutable workflow versions, start and cancel runs, read block-level results and manage heal proposals through the workflow endpoints.

  5. 5

    Triggers API reference

    Schedule and webhook trigger endpoints: the bodies for both kinds, secret rotation, the firings log and the signed public delivery endpoint.

  6. 6

    Credentials API reference

    Store portal logins in the vault over three endpoints: create with a release scope, list field names only, revoke — read-back does not exist.

  7. 7

    Pools API reference

    Manage reserved browser pools over the API: create with a total size, read warm and in-use counters, resize with PATCH and delete cleanly.

  8. 8

    Audit log API reference

    Read, seal, export and verify the hash-chained action log: entry fields, the kind vocabulary and the export bundle your own verifier checks.

  9. 9

    Errors and retries reference

    One error envelope on every endpoint: each code with its HTTP status and retryable flag, how the SDKs back off, and what 410 and 426 mean.

  10. 10

    Limits reference: every enforced number

    Every numeric limit in one table: session lengths per plan, ttlSeconds bounds, act timeouts, workflow sizes and webhook delivery rates.

  11. 11

    Usage API reference

    GET /v1/usage: metered consumption over a window as totals and UTC day buckets, in-flight sessions and the included quota. Read-only; the meter has one writer.

  12. 12

    Artifacts API reference

    GET /v1/artifacts/*: the bytes behind a workflow block’s screenshotKey, org-checked, with content type and digest headers, until the retention window ends.

  13. 13

    OAuth API reference

    The OAuth 2.1 endpoints the control plane serves for MCP connectors: discovery, dynamic registration, authorization, PKCE token exchange, refresh and revocation.

  14. 14

    Page reports API reference

    Request and response shapes for the five inference-free report endpoints on a session: consent, agent view, destinations, cancellation and screenshot.