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

Preset Profile

Available options:
custom,
cli,
web,
library,
node-compat
includeSchema
boolean

Include $schema field (IDE autocompletion)

exclude
string

exclude

nodeModulesDir
enum<string>

nodeModulesDir

Available options:
,
auto,
manual,
none
lock
string

lock

tasks
string

tasks

imports
string

imports

Use the recommended rule tag

lintRuleInclude
string

Rules to force-enable

lintRuleExclude
string

Rules to exclude

lintInclude
string

lint.include

lintExclude
string

lint.exclude

fmtUseTabs
boolean

useTabs

fmtIndentWidth
number

indentWidth

Required range: 1 <= x <= 8
fmtLineWidth
number

lineWidth

Required range: 40 <= x <= 200
fmtSingleQuote
boolean

singleQuote

fmtSemiColons
boolean

semiColons

fmtProseWrap
enum<string>

proseWrap

Available options:
always,
never,
preserve
fmtInclude
string

fmt.include

fmtExclude
string

fmt.exclude

strict
boolean

strict — enable all strict type-checking options

jsx
enum<string>

jsx

Available options:
,
react-jsx,
react-jsxdev,
react,
preserve,
react-native
jsxImportSource
string

jsxImportSource

lib
string

lib

types
string

types

checkJs
boolean

checkJs

allowJs
boolean

allowJs

noImplicitAny
boolean

noImplicitAny

strictNullChecks
boolean

strictNullChecks

noUnusedLocals
boolean

noUnusedLocals

noUnusedParameters
boolean

noUnusedParameters

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.