BrowserStack Automate API

Name: BrowserStack Automate API
Brand: BrowserStack Automate API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentDeveloper ToolsTesting Qabasic32 EndpointsREST

For Agents

Manage BrowserStack Automate projects, builds, and sessions, fetch test logs and videos, and update session status from CI. Useful for QA teams orchestrating cross-browser test runs and triaging failures.

Install Jentic One Beta

Connect the BrowserStack Automate API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the BrowserStack Automate API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with BrowserStack Automate API.

List projects, builds, and sessions to surface a CI dashboard of recent BrowserStack runs

Update session status to passed or failed from a CI step so the Automate dashboard reflects the assertion outcome

Fetch Selenium, Appium, network, console, and profiling logs for any failed session

GET STARTED

Start building with BrowserStack Automate API

Explore with Jentic

View OpenAPI Document

Jentic publishes the only available OpenAPI specification for BrowserStack Automate API, keeping it validated and agent-ready. BrowserStack Automate gives QA teams thousands of real desktop and mobile browser instances to run Selenium, Cypress, and Appium tests against. The Automate REST API exposes the metadata layer behind those test runs — projects, builds, individual sessions, log artefacts (Selenium, Appium, network, console), and media uploads — so teams can list past runs, mark sessions pass or fail from CI, fetch logs for failure analysis, and clean up old projects programmatically.

Use Cases

Patterns agents use BrowserStack Automate API for, with concrete tasks.

★ Marking Session Pass/Fail from CI

QA pipelines call PUT /automate/sessions/{sessionId}/status at the end of each test to mark the BrowserStack session as passed or failed based on the test framework's assertion result. This makes the Automate dashboard match the truth in CI rather than relying solely on Selenium's exit signal, which can mark a session passed even when the assertions failed inside the test body.

PUT /automate/sessions/{sessionId}/status with {status: 'failed', reason: 'AssertionError: expected 200 got 500'} after the test reporter completes

Failure Triage with Network and Console Logs

When a flaky cross-browser test fails on Safari but passes on Chrome, an engineer needs the network calls and console errors from that exact run to debug. The agent calls GET /automate/sessions/{sessionId}/networklogs and /consolelogs and posts the relevant excerpts into the bug report, so the next person to pick up the ticket has everything they need without re-running the test.

GET /automate/sessions/{sessionId}/networklogs and GET /automate/sessions/{sessionId}/consolelogs for a failed session and attach the JSON to the Jira ticket

Tagging Builds with Release Metadata

Release managers tag every BrowserStack build with the git branch and commit so they can later pull all sessions for release v3.4.2 from the API. PUT /automate/builds/{buildId}/tags accepts an array of tag strings; combined with GET /automate/builds.json with a tag filter, this enables release-centric reporting on top of the Automate dashboard.

PUT /automate/builds/{buildId}/tags with ['release-v3.4.2', 'main'] after the CI job records the build id

AI QA Triage Agent Through Jentic

An AI QA agent uses Jentic to triage flaky test runs without holding the BrowserStack username and access key. The agent searches for 'fetch logs for a failed BrowserStack session', loads the schema, and pulls Selenium, network, and console logs in parallel. It then summarises the likely root cause and posts to Slack, so engineers wake up to a triaged failure rather than a raw red CI badge.

Use Jentic to search 'fetch BrowserStack session logs', load the browserstack.com operations, and execute /networklogs, /consolelogs, and /seleniumlogs for the failed session

Key Endpoints

32 endpoints — jentic publishes the only available openapi specification for browserstack automate api, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

PUT

/automate/sessions/{sessionId}/status

Update session pass/fail status

GET

/automate/sessions/{sessionId}/networklogs

Fetch HAR-style network logs for a session

GET

/automate/sessions/{sessionId}/consolelogs

Fetch browser console logs

GET

/automate/sessions/{sessionId}/seleniumlogs

Fetch Selenium command logs

PUT

/automate/builds/{buildId}/tags

Tag a build with release metadata

GET

/automate/builds.json

List builds, optionally filtered

POST

/automate/upload-media

Upload a media file for tests

GET

/automate/plan.json

Get active plan and parallel session limits

PUT

/automate/sessions/{sessionId}/status

Update session pass/fail status

GET

/automate/sessions/{sessionId}/networklogs

Fetch HAR-style network logs for a session

GET

/automate/sessions/{sessionId}/consolelogs

Fetch browser console logs

GET

/automate/sessions/{sessionId}/seleniumlogs

Fetch Selenium command logs

PUT

/automate/builds/{buildId}/tags

Tag a build with release metadata

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

The BrowserStack username and access key are stored encrypted in the Jentic vault. Agents receive scoped execution tokens; raw basic-auth credentials never enter prompts or logs.

Intent-based discovery

Agents search by intent such as 'fetch BrowserStack session logs' or 'mark a session failed' and Jentic returns the matching Automate operation with its parameter schema, so the agent can call it without browsing the BrowserStack docs.

Time to first call

Direct BrowserStack Automate integration: 1-2 days for auth, log fetching, and reporting wiring. Through Jentic: under 1 hour — search, load schema, execute against an existing project.

FAQs

Specific to using BrowserStack Automate API through Jentic.

Why is there no official OpenAPI spec for BrowserStack Automate API?

BrowserStack does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call BrowserStack Automate API via structured tooling. It is validated against the live API and kept up to date. Get started at https://app.jentic.com/sign-up.

What authentication does the BrowserStack Automate API use?

The Automate API uses HTTP basic authentication with your BrowserStack username and access key (the `basicAuth` security scheme in the spec). Through Jentic, both values are stored encrypted in the MAXsystem vault and the agent receives a scoped execution token instead of the raw credentials.

Can I mark a session passed or failed from my CI pipeline?

Yes. PUT /automate/sessions/{sessionId}/status accepts {status: 'passed' or 'failed', reason: '...'}. Wire this into your test reporter so the Automate dashboard agrees with your CI step's assertion result, not just the Selenium driver's exit signal.

How do I fetch network logs for a session through Jentic?

Search Jentic for 'fetch BrowserStack session logs', load the browserstack.com schema, and call GET /automate/sessions/{sessionId}/networklogs. The response is a JSON HAR document you can attach to a bug report or pipe into a triage agent.

What are the rate limits for the BrowserStack Automate API?

The OpenAPI spec does not declare explicit rate limits. BrowserStack scales API capacity with the active plan; check GET /automate/plan.json to see your parallel session limit and avoid running large bulk delete jobs during peak CI hours.

Does this cover Live, App Live, or Percy?

No. This API covers Automate (Selenium, Cypress, Appium) only. BrowserStack Live (manual cross-browser testing), App Live (manual mobile testing), and Percy (visual review) have separate APIs that are not part of this spec.