Developers
API Playground
Interactive Enterprise API catalog in Studio: auth, limits, and links to every endpoint.
The API Playground is the interactive catalog of Stepwik’s Enterprise API (/v1/eapi/...). It mirrors what MCP and automations can call with a stepwik_* key. Open it from Studio → Developer → API Keys (Playground) or from the MCP setup guide.
Before you start
Create an API key
Create an API key in the workspace you want to automate (personal or organization).
Enable scopes
Enable the scopes required by each endpoint (see the API reference pages below).
Open the playground
Open the playground, paste the key, and optionally Remember it in this browser only.
Send a request
Pick an endpoint, fill path / query / body fields, and Send.
Inspect the response
Inspect status, latency, and JSON; copy curl, fetch, or other samples from the code tab.
Auth header used by the playground and all clients:
stepwik-api-key: stepwik_<id>_<secret>Base URL is your Stepwik API host (same origin the playground uses), with paths under /v1/eapi/....
Limits (plan + rate)
Two layers apply to playground, curl, SDKs, and MCP (MCP hops count toward the same daily quota as HTTP):
Daily plan quota
| Plan | Daily Enterprise API requests (UTC day) |
|---|---|
| Freemium | 50 / day |
| Pro / Organization (and other paid plans with API access) | Unlimited (null / ∞) |
Studio shows remaining requests on the playground when your plan has a numeric limit. When you hit the cap, further calls return PLAN_API_DAILY_LIMIT_EXCEEDED until the next UTC day.
Per-endpoint rate limits (burst)
Sliding window per API key (15 minutes):
| Endpoints | Max requests / 15 min |
|---|---|
GET /whoami |
300 |
GET /organizations, GET /billing |
120 |
| Labs list / get / format | 100 |
| Courses list / get / format | 100 |
PUT lab or course (update) |
60 |
POST lab or course (create) |
30 |
If you exceed a window you get a rate-limit error: wait or reduce traffic.
Other guardrails
- Key must match an active user (and org, for org keys) with API access on the subscription.
- Missing scopes → forbidden / missing-scope errors.
- Prefer least-privilege scopes; clear remembered keys on shared machines.
- Monitor traffic under API Keys → Usage and Logs (org keys can include
logs:read).
API reference
Each route below has its own page with method, scope, parameters, and examples, matching the Studio playground categories Account, Labs, and Courses.
Account
Whoami
Account context for the key: user id, organization id, and scopes.
List organizations
List organizations for the authenticated user (account:read).
Billing
Subscription and billing summary (billing:read).
Labs
List labs
Paginated list of labs (labs:read).
Lab format
JSON schema for LLM / MCP lab import (labs:write).
Get lab
Full lab with markdown sections (labs:read).
Create lab
Create a private draft lab (labs:write).
Update lab
Update a lab (partial) (labs:write).
Courses
List courses
Paginated list of courses (courses:read).
Course format
JSON schema for MCP course create (courses:write).
Get course
Course with ordered labs (courses:read).
Create course
Create a private draft course (courses:write).
Update course
Update a course (partial) (courses:write).
Suggested walkthrough
Confirm identity
GET /whoami to confirm workspace and scopes.
List labs
GET /labs to list content (needs
labs:read).Inspect create schema
GET /labs/format to inspect the create schema (needs
labs:write).Create a draft
POST /labs to create a draft, then open the Studio URL from the response.
Publish in Studio
Polish and publish in Studio.