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

Framework

Available options:
vanilla,
react,
reactSwc,
vue,
svelte,
solid
useTypescript
boolean

Use TypeScript (vite.config.ts)

pluginSvgr
boolean

Import SVGs as React components (vite-plugin-svgr)

pluginTsconfigPaths
boolean

Resolve aliases from tsconfig.json paths (vite-tsconfig-paths)

pluginPwa
boolean

Progressive Web App support (vite-plugin-pwa)

pluginCompression
boolean

Gzip/Brotli-compress build output (vite-plugin-compression)

pluginVisualizer
boolean

Bundle size visualizer (rollup-plugin-visualizer)

aliases
string

Path aliases

serverPort
string

Port

serverOpen
boolean

Open browser automatically on start

serverHost
boolean

Expose to network (host: true)

proxyRules
string

Dev server proxy rules

buildTarget
enum<string>

Build target

Available options:
esnext,
es2020,
es2015,
modules
outDir
string

Output directory

sourcemap
boolean

Generate sourcemaps for the build

includeComments
boolean

Include inline comments explaining each section

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.