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

Default Registry

scopedRegistries
string

Scoped Registries (optional)

authType
enum<string>

Auth Method

Available options:
none,
token,
basic,
legacy
authRegistry
string

Registry Host for Auth

tokenEnvVar
string

Token Environment Variable

basicAuthEnvVar
string

Base64 Auth Environment Variable

usernameEnvVar
string

Username Environment Variable

passwordEnvVar
string

Password Environment Variable

emailEnvVar
string

Email Environment Variable

alwaysAuth
boolean

always-auth — send credentials on every request, even anonymous GETs

saveExact
boolean

save-exact — pin installed versions instead of using a ^ range

legacyPeerDeps
boolean

legacy-peer-deps — skip peer dependency conflict checks

engineStrict
boolean

engine-strict — fail install if the "engines" field doesn't match

auditLevel
enum<string>

audit-level

Available options:
info,
low,
moderate,
high,
critical,
none
proxy
string

proxy (HTTP)

httpsProxy
string

https-proxy

noProxy
string

noproxy (comma-separated hosts)

strictSsl
boolean

strict-ssl — verify SSL certificates

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.