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
sitemapInput
string

Sitemap XML

outputFormat
enum<string>

Output format

Available options:
table,
csv,
json,
list
filterDate
enum<string>

Filter by lastmod

Available options:
all,
7,
30,
90,
365,
missing
sortBy
enum<string>

Sort by

Available options:
none,
url,
lastmod-desc,
lastmod-asc,
priority-desc,
changefreq
showValidation
boolean

Show validation warnings (missing fields, invalid priority, malformed dates)

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.