Skip to main content
Table of Contents

Automate API Reference

BrowserStack supports the use of REST API to access information about your tests via the command-line interface.

With the Automate APIs, you can get info about your Automate plan, project, build, and session details. The APIs are organized around REST and make use of the standard HTTP response codes. By default, all API responses are in the JSON format.

The following rate limits apply for API calls:

  • 1600 API requests per 5 minutes per user.
  • 160 API requests per second per IP address.

Use the following APIs as per your use-case

API Description
Plan API Obtain details about your group’s Automate plan,
Get the number of parallel sessions allowed, currently running and queued.
Browser API Get a list of all available OS, browsers, and real mobile devices.
Project APIs Get the project list, project details, update the project name, and delete a project.
Build APIs Get the list of builds, update the build name, and delete one or more builds.
Session APIs Get a list of test sessions in a build,
Mark tests as passed/failed,
Update session name or delete sessions,
Download text, network, console, Selenium, and Appium logs for debugging.
Access Key API Reset your Access Key and obtain a new one using this API.
Media API Upload, delete, and retrieve list of media files using Media APIs.

Are you new to BrowserStack?

We recommend you to check our Getting started guides for Selenium.

We're sorry to hear that. Please share your feedback so we can do better

Contact our Support team for immediate help while we work on improving our docs.

We're continuously improving our docs. We'd love to know what you liked

Thank you for your valuable feedback