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

Markdown

Simplified auto-link — turn bare URLs into clickable links

literalMidWordUnderscores
boolean

Literal mid-word underscores — don't treat some_long_name as emphasis

literalMidWordAsterisks
boolean

Literal mid-word asterisks — don't treat abc as emphasis

supportStrikethrough
boolean

Strikethrough — render text as struck-out text

supportTables
boolean

Tables — render GFM pipe tables (delimiter row needs |---|---|)

simpleLineBreaks
boolean

Simple line breaks — turn a single newline into <br> (GitHub comment style)

Open links in new window — add target="_blank" to output links

supportEmoji
boolean

Emoji — convert shortcodes like :smile: to 😄

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.