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

Name

customValue
string

Button Text

customDisabled
boolean

Disabled

customFormaction
string

Form Action

customFormenctype
enum<string>

Form Encoding Type

Available options:
,
application/x-www-form-urlencoded,
multipart/form-data,
text/plain
customFormmethod
enum<string>

Form Method

Available options:
,
get,
post
customFormnovalidate
boolean

Disable form validation

customFormtarget
enum<string>

Form Target

Available options:
,
_blank,
_self,
_parent,
_top
customClasses
string

CSS Classes

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.