# MobileBoost

- [Overview](https://docs.mobileboost.io/test-agent/overview.md): Automated mobile testing powered by the MobileBoost test agent
- [Natural language](https://docs.mobileboost.io/test-agent/natural-language.md): Define tests using plain language instructions
- [Code generation](https://docs.mobileboost.io/test-agent/code-generation.md): Automatically generate and maintain native test code from your codebase
- [CI integration](https://docs.mobileboost.io/test-agent/ci-integration.md): Upload builds and trigger tests from your CI/CD pipeline
- [Device configuration](https://docs.mobileboost.io/test-agent/devices.md): Choose between real handsets and emulators or simulators for test execution
- [Setup and cleanup calls](https://docs.mobileboost.io/test-agent/pre-requests.md): Give a test the HTTP calls that seed its state before it runs, and the ones that clean up after it
- [Test against internal environments](https://docs.mobileboost.io/test-agent/local-testing.md): Let apps on MobileBoost devices reach staging APIs and other services that are not on the public internet
- [Local testing in CI](https://docs.mobileboost.io/test-agent/local-testing-ci.md): Start and stop a tunnel around a test run in your CI pipeline
- [mb-local reference](https://docs.mobileboost.io/test-agent/local-testing-reference.md): Commands, flags, environment variables, and exit codes for the MobileBoost Local binary
- [Troubleshooting local testing](https://docs.mobileboost.io/test-agent/local-testing-troubleshooting.md): Diagnose tunnel problems, work with corporate proxies, and get the network changes you need
- [CI integration](https://docs.mobileboost.io/test-agent/reports-ci-integration.md): View test results as PR status checks via the MobileBoost GitHub App
- [Webhooks](https://docs.mobileboost.io/test-agent/reports-webhooks.md): Receive test results via HTTP webhooks after every test suite run
- [Slack notifications](https://docs.mobileboost.io/test-agent/reports-slack.md): Get test result summaries delivered to your Slack channels
- [Overview](https://docs.mobileboost.io/engineer-tooling/overview.md): Integrate MobileBoost into your development workflow
- [Getting started](https://docs.mobileboost.io/engineer-tooling/agent-skill.md): Use MobileBoost with Claude Code, Cursor, Codex, and other AI coding agents
- [MCP server](https://docs.mobileboost.io/engineer-tooling/mcp.md): Connect MobileBoost to Cursor, Claude Code, and other MCP clients
- [Interact with non-native elements](https://docs.mobileboost.io/engineer-tooling/non-native-elements.md): Test web views, hybrid components, and other non-native UI elements
- [Setup](https://docs.mobileboost.io/engineer-tooling/xcui-setup.md): Set up the MobileBoost SDK with your XCUI test suite
- [Reference](https://docs.mobileboost.io/engineer-tooling/xcui-reference.md): API reference for the MobileBoost XCUI SDK
- [Examples](https://docs.mobileboost.io/engineer-tooling/xcui-examples.md): Example tests using the MobileBoost XCUI SDK
- [Setup](https://docs.mobileboost.io/engineer-tooling/espresso-setup.md): Set up the MobileBoost SDK with your Espresso test suite
- [Reference](https://docs.mobileboost.io/engineer-tooling/espresso-reference.md): API reference for the MobileBoost Espresso SDK
- [Examples](https://docs.mobileboost.io/engineer-tooling/espresso-examples.md): Example tests using the MobileBoost Espresso SDK
- [Setup](https://docs.mobileboost.io/engineer-tooling/appium-ts-setup.md): Add the GPT Driver SDK to an existing WebdriverIO + Appium test suite (TypeScript / JavaScript)
- [Reference](https://docs.mobileboost.io/engineer-tooling/appium-ts-reference.md): API reference for the GPT Driver TypeScript SDK (gpt-driver-node)
- [Deterministic execution](https://docs.mobileboost.io/engineer-tooling/appium-ts-deterministic-execution.md): Run native Appium code first for speed and determinism, and fall back to AI only when it fails
- [Examples](https://docs.mobileboost.io/engineer-tooling/appium-ts-examples.md): Example tests using the GPT Driver TypeScript SDK
- [Setup](https://docs.mobileboost.io/engineer-tooling/appium-java-setup.md): Set up the MobileBoost SDK with your Java Appium test suite
- [Reference](https://docs.mobileboost.io/engineer-tooling/appium-java-reference.md): API reference for the MobileBoost Java Appium SDK
- [Examples](https://docs.mobileboost.io/engineer-tooling/appium-java-examples.md): Example tests using the MobileBoost Java Appium SDK
- [Setup](https://docs.mobileboost.io/engineer-tooling/appium-python-setup.md): Set up the MobileBoost SDK with your Python Appium test suite
- [Reference](https://docs.mobileboost.io/engineer-tooling/appium-python-reference.md): API reference for the MobileBoost Python Appium SDK
- [Examples](https://docs.mobileboost.io/engineer-tooling/appium-python-examples.md): Example tests using the MobileBoost Python Appium SDK
- [Self healing](https://docs.mobileboost.io/engineer-tooling/self-healing.md): Automatically adapt tests when the UI changes
- [Requirements](https://docs.mobileboost.io/qa-studio/build-requirements.md): Build file requirements for uploading to MobileBoost
- [GitHub Actions](https://docs.mobileboost.io/qa-studio/github-actions.md): Upload builds and run MobileBoost tests from GitHub Actions.
- [Overview](https://docs.mobileboost.io/qa-studio/overview.md): Create, organize, and monitor test cases in QA Studio
- [Maintaining tests](https://docs.mobileboost.io/qa-studio/maintaining-tests.md): Keep test cases up to date via the MobileBoost Test Agent or the API
- [Cloud devices](https://docs.mobileboost.io/qa-studio/ondemand-device.md): Launch virtual or physical cloud devices for test creation and debugging
- [Test recorder](https://docs.mobileboost.io/qa-studio/test-recorder.md): Record user interactions to automatically generate test steps
- [Supported instructions](https://docs.mobileboost.io/qa-studio/supported-instructions.md): Commands and AI instructions available for test steps
- [Available commands](https://docs.mobileboost.io/qa-studio/available-commands.md): Local commands available in the no-code test editor
- [Launch parameters](https://docs.mobileboost.io/qa-studio/launch-parameters.md): Pass custom data to your app at launch during test execution
- [Environment variables](https://docs.mobileboost.io/qa-studio/environment-variables.md): Store and reference sensitive values in no-code test prompts
- [Network requests](https://docs.mobileboost.io/qa-studio/network-requests.md): Make network requests before or during test execution
- [Artifacts](https://docs.mobileboost.io/qa-studio/artifacts.md): Test execution artifacts generated from cloud device runs
- [Slack notifications](https://docs.mobileboost.io/qa-studio/slack-reports.md): Get test result summaries delivered to Slack
- [Webhooks](https://docs.mobileboost.io/qa-studio/webhook.md): Receive test result notifications via webhooks
- [Getting started](https://docs.mobileboost.io/api/getting-started.md): Authenticate and make your first API request
- [Folders](https://docs.mobileboost.io/api/folders.md): Organise your test library into folders, and file tests into them
- [Create test](https://docs.mobileboost.io/api-reference/create-test.md): Create a new test case with natural-language commands.
- [Get tests](https://docs.mobileboost.io/api-reference/get-tests.md): Retrieve test cases for your organisation. Filter by test ID, title, tags, or folder. On the Platform test library, each test also reports its generated automation: the file, the rolled-up `automationState`, and under `platforms` the state on iOS and on Android separately, so a client can tell that…
- [Update test](https://docs.mobileboost.io/api-reference/update-test.md): Update an existing test. Send `testId` plus the fields you want to change; anything you omit is left as it is.
- [Delete test](https://docs.mobileboost.io/api-reference/delete-test.md): Delete one or more test cases by ID.
- [Execute tests](https://docs.mobileboost.io/api-reference/execute-tests.md): Start a run of your tests on MobileBoost devices. Each test runs the automation code MobileBoost wrote and verified for it (see `POST /tests/generate`).
- [Generate test automation](https://docs.mobileboost.io/api-reference/generate-test-automation.md): Write the automation code for a test that has a description but no working test file yet. Explores the app on a device, writes the test, verifies it by running it several times in a row, and commits it to the organisation's test repository, after which the test is runnable via `POST /tests/execute`.…
- [List folders](https://docs.mobileboost.io/api-reference/list-folders.md): List the folders your tests are organised into. Each folder carries its full path (`Checkout / Payments`) and how many tests are in it, counting its subfolders, so one call is enough to find the folder you want. `unfiledTestCount` is how many tests are in no folder at all.
- [Create folder](https://docs.mobileboost.io/api-reference/create-folder.md): Create a folder. Pass `parentId` to nest it inside another folder, or leave it out for a top-level one. Folder names are for people to read: two folders may share a name, and everything that refers to a folder uses its id.
- [Rename or move folder](https://docs.mobileboost.io/api-reference/rename-or-move-folder.md): Rename a folder, move it under another folder, or both in one call. `parentId: null` moves it back to the top level; omitting `parentId` leaves it where it is. Moving a folder takes its subfolders and its tests with it. Both halves are applied together, so a refused move never leaves the rename it c…
- [Delete folder](https://docs.mobileboost.io/api-reference/delete-folder.md): Delete a folder. **No test is deleted**: the folder's subfolders move up to its own parent and its tests become unfiled, and the response says which. To delete the tests too, call `DELETE /tests` with their ids first.
- [Move tests into a folder](https://docs.mobileboost.io/api-reference/move-tests-into-a-folder.md): File several tests into a folder at once, or unfile them with `folderId: null`. Ids that no longer exist are skipped rather than failing the call, and a test already in that folder is left alone. To move a single test, `PATCH /tests` takes `folderId` too.
- [Get run status](https://docs.mobileboost.io/api-reference/get-run-status.md): Get the status and per-test results of a run. Pass the `runId` that `POST /tests/execute` returned.
- [Upload build](https://docs.mobileboost.io/api-reference/upload-build.md): Upload an application build artifact to use in test executions.
- [XCUITest](https://docs.mobileboost.io/api/xcui-packaging.md): Package your compiled XCUITest runner and execute it on the MobileBoost device grid
- [Espresso](https://docs.mobileboost.io/api/espresso-packaging.md): Package your compiled Espresso test suite and execute it on the MobileBoost device grid
- [List audit logs](https://docs.mobileboost.io/api-reference/list-audit-logs.md): Retrieve your organisation’s audit log events as a paginated, cursor-based stream. This endpoint is intended for SIEM ingestion, such as a Splunk REST or modular input. Poll with `since=<next_cursor>` from the previous response to fetch only new events.
- [Get SDK session usage](https://docs.mobileboost.io/api-reference/get-sdk-session-usage.md): Retrieve how many AI steps your organisation's SDK sessions used over the last `days` days, grouped by the test ID each session was started with. These are the numbers the **Usage by test** table on the usage dashboard shows.
- [Changelog](https://docs.mobileboost.io/changelog.md): All updates that shipped in the Platform, the test agent, the SDKs and the API.

## OpenAPI Specs

- [openapi](/openapi.json)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.