REST API overview for Puppeteer tests

An overview of REST APIs available for Puppeteer tests on BrowserStack Automate

Important: Puppeteer testing on BrowserStack (beta) is not available to all users yet. If you’d like to get access, please submit a request here.

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.

Note: You can make up to 1600 API requests per 5 minutes per user

Pre-requisites for using the APIs for Puppeteer tests

In all of these APIs, you would need your BrowserStack credentials and in many of them, you would need the following details additionally:

  • build_id
  • session_id

Now, you can use the getSessionDetails executor in your Puppeteer tests to get hold of the build_hashed_id which is akin to build_id as specified above and hashed_id which is akin to session_id as specified above.

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.
Project APIs Get the project list, project details, update the project name, and delete a project.
Applicable for all projects within the account including projects from Selenium, Cypress etc.
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.
Get URLs for downloading text, network, console logs for debugging.
Reset Access Key API Reset your Access Key and obtain a new one using this API.

Are you new to BrowserStack?

We recommend you to check our getting-started guides for Puppeteer, Selenium or Cypress. You can also start at Documentation Home.

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

Is this page helping you?

Yes
No

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!

Talk to an Expert
Talk to an Expert