canonical: https://jentic.com/apis/lambdatest.com/lambdatest-main

# LambdaTest Screenshots API Documentation

Jentic publishes the only available OpenAPI specification for LambdaTest Screenshots API Documentation, keeping it validated and agent-ready. The LambdaTest Screenshots API automates visual screenshot capture across the LambdaTest browser and device cloud, returning rendered images for any URL across many OS, browser, and resolution combinations. It exposes endpoints to submit screenshot tests, query supported devices, locations, OS-browser pairs, and resolutions, retrieve results by test ID, stop a running test, and download captured images as a zip. Saved profiles let teams reuse capture settings across runs.

## For AI agents

Capture cross-browser and cross-device screenshots of any URL on LambdaTest's cloud and retrieve the resulting images by test ID.

## Scope

Does not handle Selenium or Appium test execution, performance profiling, or video recording - use for cross-browser screenshot capture only.

## Capabilities

- Submit a screenshot test against a URL across selected browsers, OS, and resolutions
- Query supported devices, OS-browser pairs, locations, and resolutions before configuring a run
- Retrieve captured screenshots for a specific test_id once the run completes
- Stop an in-progress screenshot test that no longer needs to finish
- Download every image from a completed test as a single zip archive
- Reuse saved capture settings via screenshot profiles for consistent visual runs

## Use cases

### Pre-Deploy Visual Smoke Test

Trigger a screenshot run for a staging URL across the top browsers used by customers and review the images before promoting a release. The Screenshots API submits the test, returns a test_id, and exposes the resulting images for inspection or AI-driven diffing. Teams typically wire this into CI to gate merges on visual parity.

Example prompt: Submit a screenshot run for https://staging.example.com on Chrome 120, Edge 119, and Safari 17 at 1920x1080, then download the zip when the test completes.

### Responsive Layout Audit

Capture the same page at mobile, tablet, and desktop resolutions to confirm the layout adapts correctly. The API accepts multiple resolutions in one submission and returns images keyed to each viewport for side-by-side review. Useful for design reviews and post-deploy checks.

Example prompt: Capture screenshots of https://example.com at 375x667, 768x1024, and 1920x1080 and report any viewport where the page fails to render.

### Browser Matrix Discovery

Query supported devices, OS-browser pairs, locations, and resolutions before submitting a run so the configuration only requests what LambdaTest actually offers. This avoids rejected submissions and keeps test matrices aligned with currently supported environments. Discovery responses can be cached in the agent's planning step.

Example prompt: Fetch /devices, /os-browsers, /locations, and /resolutions, then assemble a screenshot configuration that uses only currently supported entries.

### AI Agent Visual QA

An AI agent runs a visual smoke test as part of a larger release workflow by calling the Screenshots API through Jentic. The agent searches Jentic for screenshot capture, loads the operation schema, and submits a run in a single workflow step without manually wiring auth or paging docs. Captured images can then be passed to a vision model for layout validation.

Example prompt: Use Jentic to submit a screenshot run for the deploy preview URL on Chrome 120 desktop, then send the resulting image to a vision model for layout validation.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/` | Submit a new screenshot test. |
| GET | `/{test_id}` | Retrieve results for a screenshot test. |
| GET | `/{test_id}/zip` | Download all images from a test as a zip. |
| GET | `/stop/{test_id}` | Stop a running screenshot test. |
| GET | `/devices` | List supported devices. |
| GET | `/os-browsers` | List supported OS-browser combinations. |
| GET | `/resolutions` | List supported resolutions. |
| GET | `/profiles` | List saved screenshot profiles. |

## Key resources

- **Screenshots** — Submit, retrieve, stop, and zip-download screenshot tests.
- **Devices** — List supported physical and emulated devices.
- **OS-Browsers** — List supported OS and browser combinations.
- **Locations** — List supported geographic capture locations.
- **Resolutions** — List supported viewport resolutions.
- **Profiles** — Saved capture configurations.

## Why Jentic

- **Setup:** Wiring the LambdaTest Screenshots API by hand means encoding its username and access key for basic auth, targeting the api.lambdatest.com host, and polling for capture jobs to finish yourself. Through Jentic you install once, import the LambdaTest Screenshots API from the API Directory, store the username and access key once, and your agent calls it.
- **Permission scoping:** You choose which LambdaTest operations the agent may call, so you can limit it to the ones it needs, such as starting a screenshot capture and reading the result. Read-only lookups like listing devices, browsers, or resolutions can be allowed without granting the ability to stop running tests.
- **Credential handling:** Your LambdaTest username and access key are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'capture a screenshot across browsers' or 'list available devices', and Jentic returns the matching LambdaTest Screenshots operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **BrowserStack** — BrowserStack offers a comparable cross-browser screenshot service with a larger real-device cloud.
- **Sauce Labs** — Sauce Labs provides browser and device cloud testing with broader Selenium and Appium control.
- **Urlbox** — Urlbox is a screenshot-focused API with predictable image output and post-processing options.
- **Browserless** — Browserless runs headless Chrome jobs that pair with LambdaTest for ad hoc captures.

## FAQ

### Why is there no official OpenAPI spec for LambdaTest Screenshots API Documentation?

LambdaTest does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call LambdaTest Screenshots API Documentation via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the LambdaTest Screenshots API use?

The API uses HTTP Basic auth with a LambdaTest username and access key. Through Jentic, the credentials live in the encrypted vault and are injected at execution time so the access key never enters the agent context.

### Can I capture screenshots across many browsers in one request with the LambdaTest Screenshots API?

Yes. A single POST to / accepts an array of browser, OS, and resolution combinations and returns one test_id covering them all. Run GET /os-browsers first to confirm each pair is supported.

### What are the rate limits for the LambdaTest Screenshots API?

Rate limits depend on plan tier and parallel session quota; the spec does not enumerate them. Check your plan settings at lambdatest.com for current concurrent screenshot limits.

### How do I capture and download screenshots through Jentic?

Search Jentic for 'capture screenshots across browsers', load the schema, POST to / to submit the run, then GET /{test_id}/zip with the returned test_id to download every image as one archive.

### Can I cancel a running screenshot test with the LambdaTest Screenshots API?

Yes. Call GET `/stop/{test_id}` with the test_id returned from the original submission to halt an in-progress capture before it finishes.

### Can I limit what my agent is allowed to do with the LambdaTest Screenshots API?

Yes. Because you run your own self-hosted Jentic One instance, your rules decide which LambdaTest Screenshots operations and credentials the agent may use. You can restrict it to just the operations it needs, such as submitting a screenshot capture (POST /) and reading the result (GET /{test_id}), while allowing read-only lookups like listing devices, OS-browser pairs, or resolutions. That means an agent can discover supported environments and capture screenshots without ever being granted the ability to stop a running test.