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

Page title

description
string

Meta description

url
string

Page URL

query
string

Search query

device
enum<string>

Device

Available options:
desktop,
mobile
siteName
string

Site name

favicon
boolean

Show favicon

date
string

Date prefix

rating
boolean

Show star rating

ratingValue
number

Rating

Required range: 0 <= x <= 5
ratingCount
number

Review count

descriptionLimit
number

Description character limit

Required range: 80 <= x <= 350

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.