Capture a full-page screenshot. Free 5 times a day per client address when the request carries no credential or key; then 0.02 USD per call. A page whose full layout exceeds 25,000,000 pixels (about 17,361 px tall at 1440 px wide) is captured from the top down to the part that fits.

post/screenshots

Request

  • Base URL: https://app.difficat.com/api/v1
  • URL: https://app.difficat.com/api/v1/screenshots
  • Auth: one of:
    • HTTP payment
    • HTTP bearer

Headers

Idempotency-Keystring

For a prepaid key: a retry of the same request (same route and body) carrying the same value within 24 hours is not debited again and is answered 409 naming the job the first request created; the same value on another body is a new request (draft-ietf-httpapi-idempotency-key-header).

Request body

urlstring uri required
viewportWidthinteger

Response

OK

jobIdstring required
jobTokenstring required

Bearer token for the file link. Shown once.

filenamestring required
urlstring uri required
pagesChargedinteger

0 on a free run.

sampleboolean

Present and true when the call ran under the free daily allowance; payment is then absent.

allowanceRemaininginteger

Free run: the units of this kind left for the address today.

Example response

{
  "payment": {
    "amount": "0.50"
  }
}

Changes

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