Byte Engine Docs
Inspectorhttp

Capture screenshots from the same frame

POST/screenshots

Captures up to 16 images, from any sinks and capture points, in one graphics frame, so you can compare targets that belong together. Each capture takes the same fields as the GET /screenshots query. The response is multipart/form-data with one part per capture, in request order. Each part is named by its zero-based capture index, has a file name built from the capture, and carries the same Content-Type and X-Byte-Engine-* headers as a single-image response, except X-Byte-Engine-Frame, which the response itself carries. If any capture fails, the request fails, and the error message starts with the failing capture index.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

captures*array<>
Items1 <= items <= 16

Response Body

multipart/form-data

text/plain

text/plain

text/plain

text/plain

text/plain

text/plain

curl -X POST "https://example.com/screenshots" \  -H "Content-Type: application/json" \  -d '{    "captures": [      {        "sink": 0      },      {        "sink": 0,        "target": "Diffuse Radiance History",        "format": "exr"      },      {        "sink": 0,        "target": "Diffuse Radiance History",        "previous": true,        "format": "exr"      }    ]  }'
{  "property1": "string",  "property2": "string"}