Overview of App Automate REST API | BrowserStack Docs
"+$(n+2)+""+$(n)+"\n"}function K(e,t,n){return L(e)?(n?$(n).slice(1):"")+'

'+R(O(e))+"

\n":""}function i(e,t,n,o){var r,i,s,a,l=n[0];if(1===n.length){for(a=X(t,l),r='
\n'+K(l.name,a,0),s=0;s\n"}for(r='
\n',i=0;i\n'+K(n[i].name,a,26),s=0;s\n"}return r+"
\n"}function Q(e,t){var n,o='
'+$(14)+'
'+$(16)+'
'+$(18)+'

'+R(t.description)+"

"+$(16)+"
"+$(16)+'
'+$(18)+'
\n';for(n=0;n"+$(16)+"
"+$(14)+"
"+$(12)+"
\n"}function ee(e,t){var n,o,r,i,s='
',a=[];if(!t.explore.length)return s+"
\n";for(n=0;n"+$(20)+''+$(22)+i+$(20)+""+$(18)+""));return s+$(12)+'
'+$(14)+'
'+$(16)+'

'+$(18)+p+a.join('')+"

"+$(14)+"
"+$(12)+"
"+$(10)+"
\n"}function te(e,t,n){var o,r,i="",s="",a="";for(o=0;o'+$(12)+'

'+R(r.name)+"

"+$(12)+'

'+R(r.description)+"

"+$(10)+"",s+=Q(n,e[o]),a+=ee(n,e[o]);return n.anchors?J('
    ","products",t,$(2)+"
  • "+$(4)+'
    '+$(6)+$(6)+'
    '+$(8)+'
    \n'+i+"\n
    "+$(8)+$(8)+$(8)+'
    '+$(10)+$(10)+'
    '+$(10)+$(10)+'
    \n'+s+"
    "+$(8)+"
    \n"+$(8)+$(8)+'
    \n'+a+"
    "+$(8)+$(8)+"
    "+$(6)+"
    "+$(4)+"
    "+function(e){var t,n,o="";for(t=0;t".length).replace(/ id="([^"]+)"/g,' id="$1-'+n+'"').replace(/url\(#([^)]+)\)/g,"url(#$1-"+n+")")+"";return o?'\n":""}(n)+$(2)+"
    • \n"):""}function ne(e,t){var n,o,r,i,s,a,l,c,d=e.meta.slug,u="";for(n=0;n'+(L(c)?R(O(c)):"")+"\n"),r=0;r'+$(l+2)+'"+$(l+4)+'
    '+$(l+6)+R(a.label)+$(l+4)+"
    "+$(l+4)+'
    '+$(l+6)+R(a.description)+$(l+4)+"
    "+$(l+2)+"    "+$(l)+"\n");if(e.explore.length)for(u+='
  • '+$(14)+p+$(10)+"
    • \n",r=0;r'+$(14)+'"+R(e.explore[r].label)+""+$(10)+"\n";return J('
      ","products-mobile-"+d,t,$(10)+'
    • '+$(14)+'"+$(10)+"
      • \n"+u)}function oe(e,t){var n,o=V("products",t),r=V("developers",t),i=function(e,t){var n,o,r,i,s,a,l,c,d,u=t.components.products_dropdown.tabs,p=[];for(n=0;n'+$(20)+'"+o+""+$(18)+"\n";return r?J('
        ","developers",t,"\n"+r):""}(s,e.version),a["products-mobile-tabs"]=a.products?function(e,t){var n,o="";for(n=0;n'+$(16)+'
        '+$(20)+R(e[n].name)+$(20)+M+$(16)+"
        "+$(16)+'
        '+R(e[n].description)+"
        "+$(14)+"";return J('
      • ","products-mobile-tabs",t,$(12)+'"+o+"\n")}(i,e.version):"",n=0;n"+R(e[n].label)+"
        • \n";return o?J('
          ","developers-mobile",t,$(8)+'
        • '+$(12)+'"+$(8)+"
          • \n"+o):""}(s,e.version),a}function re(e,t){var n,o,r,i,s,a,l,c,d={};if(!k(e)||!A(e.schema_version)||!u(e.version))return!1;if(null!=t&&e.version!==t)return!1;if(n=e.components,!(k(e.products)&&k(e.links)&&k(n)&&k(n.products_dropdown)))return!1;if(!x(o=n.products_dropdown.tabs)||!o.length)return!1;for(r=0;r
No Result Found
Get your setup working faster. Join our Discord for optimisation tips from elite testers. Join our DiscordJoin our Discord

Overview of App Automate REST API

Test native and hybrid mobile apps on thousands of real devices using Appium, Espresso, or XCUITest using the BrowserStack App Automate REST API.

Welcome to the App Automate REST API reference. This API provides powerful, programmatic access to the BrowserStack real device cloud, allowing you to manage your complete mobile testing lifecycle.

Use these endpoints to:

  • Upload your app (.apk, .aab, .ipa) and test suite (.zip) files. In Appium, .xapk files are also supported.

  • Execute test runs for any supported framework.

  • Retrieve detailed test results, logs, and media assets.

This API is the key to integrating BrowserStack App Automate directly into your CI/CD pipeline. It follows standard REST conventions and returns responses in JSON format.

Base URL

https://api-cloud.browserstack.com/

App Automate REST API enables you to run your mobile automation tests and integrate your CI/CD pipeline with BrowserStack. The API follows the general conventions of REST. Most API endpoints return responses in JSON format.

The following rate limits apply for API calls:

  • APIs - 90 requests/second per user.
  • App/Test suite Uploads - 5 requests/per minute per user.

API reference

The API reference documentation is organized into the following sections:

App Automate framework Version
Appium API
Test native and hybrid apps using Appium automation framework on real iOS & Android devices		 v1
Maestro API
Test native and hybrid apps using Maestro automation framework on real Android and iOS devices		 v1
Espresso API
Test native and hybrid apps using Espresso automation framework on real Android devices		 v2
Flutter Android API
Test native and hybrid apps using Flutter automation framework on real Android devices		 v2
Flutter iOS API
Test iOS packages using Flutter automation framework on real iOS devices		 v2
Detox Android API
Test native apps using Detox automation framework on real Android devices		 v2
XCUITest API
Test native and hybrid apps using XCUITest automation framework on real iOS devices		 v2
Media API
Test scenarios that require sample test data to be made available to your apps during test execution		 v1

Are you new to BrowserStack?


We recommend checking out our Getting started documentation for Appium, Espresso, XCUITest, Flutter, Detox, and Maestro.

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

Download Copy Check Circle