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
format
enum<string>

Config Format

Available options:
flat,
legacy
framework
enum<string>

Framework / Environment

Available options:
vanilla,
node,
react,
nextjs,
vue,
typescript
styleGuide
enum<string>

Style Guide

Available options:
none,
airbnb,
standard,
google,
prettier
useTypescript
boolean

Use TypeScript (@typescript-eslint)

ecmaVersion
enum<string>

ecmaVersion

Available options:
latest,
2024,
2023,
2022,
2021,
2020,
2019,
2018
sourceType
enum<string>

sourceType

Available options:
module,
commonjs,
script
envBrowser
boolean

browser globals (window, document, fetch)

envNode
boolean

node globals (process, require, __dirname)

envJest
boolean

jest globals (describe, test, expect)

envMocha
boolean

mocha globals

ruleSemi
enum<string>

semi (require semicolons)

Available options:
error,
warn,
off
ruleQuotes
enum<string>

quotes

Available options:
single,
double,
backtick,
off
ruleIndent
enum<string>

indent

Available options:
2,
4,
tab,
off
ruleNoUnusedVars
enum<string>

no-unused-vars

Available options:
error,
warn,
off
ruleNoConsole
enum<string>

no-console

Available options:
error,
warn,
off
ruleEqeqeq
enum<string>

eqeqeq (strict equality)

Available options:
error,
warn,
off
rulePreferConst
enum<string>

prefer-const

Available options:
error,
warn,
off
ruleNoVar
enum<string>

no-var

Available options:
error,
warn,
off
includeComments
boolean

Include inline comments explaining each option

includeHeader
boolean

Include descriptive header comment

includeInstall
boolean

Include npm install command at top

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.