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
preset
enum<string>

Context Preset

Available options:
custom,
api,
staticAsset,
htmlPage,
privateData
public
boolean

public

private
boolean

private

noCache
boolean

no-cache

noStore
boolean

no-store

maxAge
number

max-age (seconds)

Required range: x >= 0
sMaxage
number

s-maxage (seconds)

Required range: x >= 0
staleWhileRevalidate
number

stale-while-revalidate (seconds)

Required range: x >= 0
staleIfError
number

stale-if-error (seconds)

Required range: x >= 0
mustRevalidate
boolean

must-revalidate

proxyRevalidate
boolean

proxy-revalidate

immutable
boolean

immutable

noTransform
boolean

no-transform

mustUnderstand
boolean

must-understand

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.