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
url
string
required

URL

method
enum<string>

HTTP Method

Available options:
GET,
POST,
PUT,
PATCH,
DELETE,
HEAD
headers
string

Headers

body
string

Request Body

basicAuthUser
string

Basic Auth Username

basicAuthPass
string

Basic Auth Password

followRedirects
boolean

Follow redirects (-L)

insecure
boolean

Skip SSL certificate verification (-k)

verbose
boolean

Verbose output (-v)

includeHeaders
boolean

Include response headers (-i)

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.