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

Mode

Available options:
sitemap,
sitemapindex
urls
string

URLs

indexUrls
string

Sitemap URLs

defaultChangefreq
enum<string>

Change Frequency

Available options:
,
always,
hourly,
daily,
weekly,
monthly,
yearly,
never
defaultPriority
enum<string>

Priority

Available options:
,
1.0,
0.9,
0.8,
0.7,
0.6,
0.5,
0.4,
0.3,
0.2,
0.1,
0.0
autoLastmod
boolean

Use today's date as lastmod for URLs without one

autoLastmodIndex
boolean

Use today's date as lastmod for every sitemap

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.