Using identify_as_hcti

Identify a URL screenshot request as coming from HTML/CSS to Image.

How it works

Set identify_as_hcti to true to add this header to the top-level page request:

X-HCTI-SCREENSHOT: 1

The parameter is available for URL screenshots and defaults to false. The header is not added to page subrequests.

Use it when your application wants to:

Detect screenshot requests at the origin.
Select screenshot-specific content or styling.
Label requests in application logs.

Not an authentication mechanism

The header name and value are public and predictable. Do not use identify_as_hcti by itself to authorize access or bypass security controls. Use a private value with the headers parameter when the origin must authenticate the render.

JSON example

{
  "url": "https://example.com/report",
  "identify_as_hcti": true
}

Form example

curl -X POST https://hcti.io/v1/image \
  -u 'UserID:APIKey' \
  --data-urlencode 'url=https://example.com/report' \
  --data 'identify_as_hcti=true'

For a private header name or value, use the headers parameter.

Need help?

We’re always looking to improve this documentation. Please send us an email: support@htmlcsstoimage.com. We respond fast.