API Authentication

You can access Stormkit API by using API Keys. Currently, there are three-level API keys:

User Level API Key

1. Click on your profile picture on the top-right corner
2. Select Account
3. Scroll down to the API Keys section
4. Create a new API Key

This API Key will grant programmatic access to everything in your Stormkit account.

Team Level API Key

1. Expand the Team toggle on top-left corner of the page
2. Select the gear icon of the Team you would like to access to
3. Create a new API Key

This API Key will grant access to all applications owned by the team.

Environment Level API Key

1. Visit Your App > Your Environment > Config > Other > API Keys
2. Create a new API Key

This API Key will grant access to the specified environment.

Important: The API key token is displayed only once immediately after creation. Make sure to copy it before closing the dialog — it cannot be retrieved afterwards. If you lose the key, delete it and create a new one.

Authenticating

Once the API Key is obtained, add an Authorization header and use the API key. For example:

# Using the User Level API Key:

curl -X GET \
     -H 'Authorization: Bearer <api_key>' \
     -H 'Content-Type: application/json' \
     'https://api.stormkit.io/v1/snippets?envId=4151'

# Using the Team Level API Key:

curl -X GET \
     -H 'Authorization: <api_key>' \
     -H 'Content-Type: application/json' \
     'https://api.stormkit.io/v1/apps'

# Using the Environment Level API Key:

curl -X GET \
     -H 'Authorization: <api_key>' \
     -H 'Content-Type: application/json' \
     'https://api.stormkit.io/v1/redirects?appId=48961&envId=58181'

OpenAPI specification

The full API surface is published as an OpenAPI 3.1 document. Every operation carries a unique operationId, a description, typed parameters and response schemas, so it can be loaded straight into an API client or turned into function-calling tools for an agent.

• https://api.stormkit.io/v1/openapi.json — served by the API itself, no authentication required. On a self-hosted instance, use your own API host.
• https://www.stormkit.io/openapi.json — the same document on the website.

curl -s 'https://api.stormkit.io/v1/openapi.json' | jq '.paths | keys'

Error responses

Every failing call answers with JSON:

{
  "error": "The API key is missing, invalid, or does not grant access to this resource.",
  "code": "forbidden",
  "docs": "https://www.stormkit.io/docs/api/authentication"
}

Field	Description
error	Human-readable description of what went wrong.
code	Stable, machine-readable identifier — branch on this, not on the message.
docs	Present on authentication failures: the page explaining how to resolve them.
errors	Present on validation failures: a message per rejected field, keyed by field name.

Common codes: forbidden (missing, invalid or too narrowly scoped key), unauthorized (no credentials at all), not-found (the addressed resource does not exist or is not visible to the key), unknown-endpoint (no such path — check the OpenAPI document), method-not-allowed (wrong HTTP method for the path).