Metadata options

Reference for the metadata options of the shotkit screenshot API, with an example request for each.

Extra information about the page. With response_type=json it is returned in the JSON body; otherwise each field is sent as an X-… response header (URL-encoded JSON).

`metadata_image_size`

Return image width/height.

Type: boolean · Default: false

curl -X POST "https://shotkit.net/api/take" \
  -H "X-Access-Key: YOUR_ACCESS_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com","response_type":"json","metadata_image_size":true}' \
  --fail-with-body -o shot.json

`metadata_page_title`

Return the page title.

Type: boolean · Default: false

curl -X POST "https://shotkit.net/api/take" \
  -H "X-Access-Key: YOUR_ACCESS_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com","response_type":"json","metadata_page_title":true}' \
  --fail-with-body -o shot.json

`metadata_icon`

Return the favicon URL.

Type: boolean · Default: false

curl -X POST "https://shotkit.net/api/take" \
  -H "X-Access-Key: YOUR_ACCESS_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com","response_type":"json","metadata_icon":true}' \
  --fail-with-body -o shot.json

`metadata_open_graph`

Return Open Graph tags.

Type: boolean · Default: false

curl -X POST "https://shotkit.net/api/take" \
  -H "X-Access-Key: YOUR_ACCESS_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com","response_type":"json","metadata_open_graph":true}' \
  --fail-with-body -o shot.json

`metadata_fonts`

Return fonts used by the page.

Type: boolean · Default: false

curl -X POST "https://shotkit.net/api/take" \
  -H "X-Access-Key: YOUR_ACCESS_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com","response_type":"json","metadata_fonts":true}' \
  --fail-with-body -o shot.json

`metadata_content`

Also store page content and return its URL. Uploads the page's HTML (or Markdown) next to the screenshot and returns its URL, so you get a screenshot and the text in one render.

Type: boolean · Default: false

curl -X POST "https://shotkit.net/api/take" \
  -H "X-Access-Key: YOUR_ACCESS_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com","response_type":"json","metadata_content":true}' \
  --fail-with-body -o shot.json

`metadata_content_format`

Content format.

Type: enum · Default: html

Values: html, markdown

curl -X POST "https://shotkit.net/api/take" \
  -H "X-Access-Key: YOUR_ACCESS_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com","response_type":"json","metadata_content":true,"metadata_content_format":"markdown"}' \
  --fail-with-body -o shot.json

`metadata_http_response_status_code`

Return the target's HTTP status.

Type: boolean · Default: false

curl -X POST "https://shotkit.net/api/take" \
  -H "X-Access-Key: YOUR_ACCESS_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com","response_type":"json","metadata_http_response_status_code":true}' \
  --fail-with-body -o shot.json

`metadata_http_response_headers`

Return the target's HTTP headers.

Type: boolean · Default: false

curl -X POST "https://shotkit.net/api/take" \
  -H "X-Access-Key: YOUR_ACCESS_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com","response_type":"json","metadata_http_response_headers":true}' \
  --fail-with-body -o shot.json