Skip to main content
POST

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
forceHttps
boolean

Force HTTPS (redirect HTTP → HTTPS)

wwwMode
enum<string>

www canonicalization

Available options:
none,
non-www,
www
disableDirListing
boolean

Disable directory browsing (Options -Indexes)

denySensitiveFiles
boolean

Deny access to sensitive files (.env, .git, .htaccess…)

blockHotlinking
boolean

Prevent image hotlinking

allowedDomain
string

Allowed domain

customError
boolean

Custom 404 error page

errorPage
string

404 page path

gzip
boolean

Enable GZIP compression

browserCaching
boolean

Enable browser caching (Expires headers)

cacheDays
number

Cache lifetime (days)

Required range: 1 <= x <= 365

Response

Tool output

outputs
object
required
tool
string
required

The tool's slug, echoing the {slug} in the request path.

tool_version
string
required

Output-contract version for this tool.

credits_used
integer
required

Credits this call consumed, after any settlement refund. 0 when metering is disabled.

credits_remaining
integer | null
required

Credits left in the current monthly allowance, or null when metering is disabled.

request_id
string

Correlation id, also sent as x-request-id.