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
​
comment
string

Header Comment (optional)

​
defaultDisallow
string

Disallow paths

​
defaultAllow
string

Allow paths (optional)

​
defaultCrawlDelay
number

Crawl-delay (seconds, optional)

Required range: x >= 0
​
botAgent
enum<string>

User-agent

Available options:
,
Googlebot,
Googlebot-Image,
Bingbot,
YandexBot,
DuckDuckBot,
Baiduspider,
GPTBot,
ChatGPT-User,
Google-Extended,
CCBot,
anthropic-ai,
ClaudeBot,
PerplexityBot,
Twitterbot,
AhrefsBot,
SemrushBot,
Applebot,
__custom__
​
botAgentCustom
string

Custom user-agent

​
botDisallow
string

Disallow paths

​
botAllow
string

Allow paths (optional)

​
botCrawlDelay
number

Crawl-delay (seconds, optional)

Required range: x >= 0
​
sitemapUrls
string

Sitemap URL(s)

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.