> For the complete documentation index, see [llms.txt](https://docs.sonoransoftware.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints-v2/iframe-endpoints/screenshot-capture.md).

# Screenshot Capture

Capture the current embedded CAD viewport as a PNG data URL.

Send `scad:screenshot:request` to capture the visible CAD viewport:

```javascript
cadFrame.contentWindow.postMessage({
  type: 'scad:screenshot:request',
  requestId: 'capture-1',
  options: {
    maxWidth: 1920,
    maxHeight: 1080,
    scale: window.devicePixelRatio,
  },
}, cadOrigin);
```

All options are optional. The default maximum output size is 1920 by 1080 pixels. `scale` controls the requested pixel ratio, but the result is reduced as needed to remain within `maxWidth` and `maxHeight`.

CAD responds with a PNG data URL and its pixel dimensions:

```json
{
  "type": "scad:screenshot:response",
  "requestId": "capture-1",
  "image": "data:image/png;base64,...",
  "width": 1920,
  "height": 1080
}
```

Only one capture can run at a time. Failures return `scad:screenshot:error`:

```json
{
  "type": "scad:screenshot:error",
  "requestId": "capture-1",
  "error": "capture_in_progress"
}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.sonoransoftware.com/cad/api-integration/api-endpoints-v2/iframe-endpoints/screenshot-capture.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.