Screenshots

Take a screenshot (alias, JSON body)

Same as the GET form, with the options sent as a JSON object. Use it for html, markdown, styles, scripts and other long values.

post/api/v1/take

Request

  • Base URL: https://curlshot.com
  • URL: https://curlshot.com/api/v1/take
  • Auth: one of:
    • API key in query parameter access_key
    • API key in header X-Access-Key
    • HTTP bearer

Request body

OR
OR

Response

The rendered file. With response_type=json the body is JSON describing the stored file instead.

idstring required

Reference id of the render.

urlstring uri nullable required

Link to the stored file. It carries its own expiring token and needs no access key.

format'png' | 'jpeg' | 'webp' | 'pdf' | 'mp4' | 'webm' | 'gif' required
bytesinteger required
widthinteger nullable
heightinteger nullable
render_msinteger nullable
cachedboolean

True when a stored copy was served.

expires_atstring date-time nullable

When the stored file is removed and its link stops working.

Changes

No recorded changes to this operation across all 1 revision of this API.