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

Source URL

customTitle
string

Title

customAllowFullscreen
boolean

Allow Fullscreen

customLoading
enum<string>

Loading Type

Available options:
eager,
lazy
customReferrerPolicy
enum<string>

Referrer Policy

Available options:
no-referrer,
no-referrer-when-downgrade,
same-origin,
strict-origin-when-cross-origin,
unsafe-url
customHeight
number

Height

Required range: x >= 1
customWidth
number

Width

Required range: x >= 1
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.