> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stateset.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Capture a screenshot with options (format, quality, region)

> Screenshot as base64-encoded image

> [!WARNING]
>
> **Confirm your deployment before running this request.** This page describes an API contract;
> a published reference does not establish hosted availability. Check the dated
> [host report](https://docs.stateset.com/api-reference/hosts.md) and obtain your deployment URL and credentials.
> Replace the example host if your provisioned service uses a different URL.

### Path parameters

**id** `string (uuid)` *required*

Sandbox identifier

### Request body

`ScreenshotRequest`

**format** `string`

Allowed values: `'png'`, `'jpg'`, `'jpeg'`. Default: `'png'`.

**quality** `integer`

Default: `85`. Minimum: `1`. Maximum: `100`.

**region** `object`

**region**

**x** `integer` *required*

Minimum: `0`. Maximum: `9007199254740991`.

**y** `integer` *required*

Minimum: `0`. Maximum: `9007199254740991`.

**width** `integer` *required*

Minimum: `1`. Maximum: `9007199254740991`.

**height** `integer` *required*

Minimum: `1`. Maximum: `9007199254740991`.

### Response

`object`

**image** `string (byte)` *required*

Base64-encoded image data.

**format** `string` *required*

Allowed values: `'png'`, `'jpg'`.

### Status codes

| Code | Meaning |
| - | - |
| `200` | Screenshot as base64-encoded image |
| `400` | Invalid request |
| `404` | Sandbox not found |
| `500` | Screenshot capture failed |

### Using this contract

Read the [source OpenAPI document](https://docs.stateset.com/spec/sandbox.json) for declared schemas and alternatives.
This page also includes documented corrections from the [spec overlays](https://github.com/stateset/docs/tree/main/spec/overlays).
Example IDs and values are illustrative; replace them with records from your workspace.

```bash cURL theme={null}
curl --silent --show-error --fail-with-body --request POST \
  --url 'https://api.sandbox.stateset.app/api/v1/sandbox/{id}/screenshot' \
  --header 'Authorization: ApiKey YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "format": "png",
  "quality": 85,
  "region": {
    "x": 1,
    "y": 1,
    "width": 1,
    "height": 1
  }
}'
```

```json 200 theme={null}
{
  "image": "aGVsbG8=",
  "format": "png"
}
```


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