Questions, answered.
Pricing, features, mock servers, MCP, SDKs, monitoring — every common question with a real answer. No marketing fluff.
22 questions across 6 topics
Getting started
What API spec formats are supported?
OpenAPI 3.x, Swagger 2.0, and GraphQL SDL. Upload a JSON or YAML file, paste raw content, or point us at a URL — we fetch and parse it automatically.
Can I use my own domain?
Yes, on the Business plan. Serve your docs at docs.yourcompany.com with an auto-provisioned SSL certificate. Add one CNAME record and we take it from there.
Mock server
Does Outworx ship a hosted mock server?
Yes. Every public, non-password-protected project gets a free hosted mock URL the moment its spec uploads — `docs.outworx.io/mock/<slug>/...` for OpenAPI/Swagger, and POST `/mock/<slug>/graphql` for GraphQL specs. Responses come from explicit `example` fields in your spec, named examples cycled via the standard `Prefer: example=<name>` header, schema-driven samples with faker output (uuid, email, date-time), or stateful overrides you pin from the dashboard. Two-layer rate limiting (120 req/min per project, 60 req/min per IP), open CORS, no built-in auth.
Can I customize mock responses without changing my spec?
Yes — that's what stateful overrides do. From the Mock Server dashboard tab, pin a custom (status, body, headers) for any (method, path) combination. Match by query params, headers (case-insensitive with `*` wildcards), a deep-partial JSON body shape, or — for GraphQL — the operation name. Priority + first-match-wins ordering, optional latency simulation. Override bodies render dynamic placeholders like `{{$uuid}}`, `{{$now}}`, `{{$randomEmail}}`, `{{request.body.email}}`, and `{{request.path.id}}` so a single rule can return fresh data per request without standing up a separate mock service.
Can the mock server validate requests or enforce auth?
Yes — both are opt-in toggles per project. **Strict request validation** checks every incoming request against the matched operation's spec (required path / query / header parameters, JSON body schema, types, enums, formats) and returns 400 with field-level errors when it fails. **Auth enforcement** reads your spec's security schemes and returns 401 with `WWW-Authenticate` when the required apiKey, Bearer, Basic, OAuth2, or OpenID Connect credential is missing. Both off by default so existing test suites that rely on a permissive mock keep working until you flip the toggle.
What plan limits apply to the mock server?
Free includes 10,000 mock requests / month, 5 stateful overrides per project, and a 24-hour activity log — auth enforcement, strict validation, and override templating are all on. Pro ($9/mo) raises to 100,000 requests / month, 25 overrides, a 14-day activity log, plus network simulation (configurable latency band + chaos error rate for stress-testing retry / loading code) and override import/export bundles for staging↔prod parity. Business ($19/mo) is unlimited mock requests, 50 overrides, 30-day log, all features. Limits gate against the project owner's plan so a Free collaborator on a Business project gets Business caps.
Webhooks
Can Outworx capture and replay webhooks?
Yes. The /webhooks workspace gives every account a unique capture URL — paste it into Stripe, GitHub, Slack, or anything else that emits webhooks, and incoming requests stream into your dashboard in real-time. Click Send-test to fire a signed payload at your own handler, or Replay to re-send any captured request to a different URL with the original payload + headers preserved. The HMAC verifier covers Stripe, GitHub, Shopify, Square, Linear, HubSpot, Zoom, Zendesk, Slack, plus raw HMAC variants — your signing secret is computed entirely in the browser and never crosses our network. Free includes 5 inboxes and 500 captures over a 7-day window.
Can I lock a webhook inbox down for production traffic?
Yes. Open the inbox's Security panel to enforce any combination of HMAC signature verification (8 branded schemes — Outworx, Stripe, GitHub sha256/sha1, Slack, Shopify, Linear, Zendesk — plus a Custom HMAC mode where you pick the header name, algorithm, and encoding), HTTP Basic auth, and a source-IP allowlist with IPv4/IPv6 CIDR ranges. Each layer is independent and rejects unsigned, unauthenticated, or off-network requests with the right HTTP status (401/403) before anything is persisted. Replays auto-sign with the inbox's stored secret using the configured scheme, so the locked-down inbox accepts its own replays without having to re-paste the secret each time. Defaults stay open, so the zero-config 'paste the URL into a sender' workflow keeps working until you opt in.
AI & MCP
What is the MCP server and who uses it?
Every Pro and Business project gets its own MCP server — one URL plus a token that plugs into Claude Desktop, Cursor, Cline, Continue, or any MCP-aware tool. Developers using your API can connect it to their AI assistant and the model gains 12 tools: list/search endpoints, generate TypeScript types, run live calls with their own credentials, ask grounded questions, and more. Response shapes from live calls are inferred and merged into a stored schema, so generated types stay accurate even for endpoints your OpenAPI spec under-documents.
How does the AI chat on my docs work?
Pro and Business docs get a floating Ask AI button. It opens a chat drawer trained only on your API spec — visitors ask questions, get Markdown answers with real code examples, and every endpoint reference is a clickable deep-link. All chats are logged in your dashboard so you can see what visitors actually ask. Pro gets 25k tokens/day, Business gets 200k.
How do descriptions, code examples, and search work?
Auto-generate endpoint descriptions when your spec is sparse. Get code examples in any language or framework (NestJS, Django, Rails, Rust…) with realistic sample data. Free docs get natural-language search; paid docs get unlimited per-endpoint AI help.
API platform
How does the Try It playground work?
Every endpoint has an interactive request builder. Fill params, set headers, add a body, send a real request, see the response — all inline. Shared auth headers persist across all endpoints so you set your API key once. Local dev APIs work too via our outworx-proxy CLI.
Do you generate SDKs from my spec?
Yes — TypeScript and Python today, and the generator is format-aware: HTTP specs (OpenAPI / Swagger) get one typed function per endpoint with a Client class that bundles auth + base URL; GraphQL specs get one typed function per Query / Mutation / Subscription field with default selection sets baked in (and a `query` override per call). One drop-in `.ts` or `.py` file, native fetch / httpx, no codegen toolchain. Re-download from the dashboard or pipe through `curl` in CI whenever your spec changes.
Can Outworx detect breaking changes in my spec on PRs?
Yes. The Diffs tab compares any two project versions and suggests a semver bump (major / minor / patch). Drop the Outworx GitHub Action into `.github/workflows/` and every PR that touches your spec gets an automatic comment showing breaking changes, additive changes, and the suggested release bump — before reviewers approve.
Do you offer uptime monitoring and a status page?
Yes. Toggle monitoring per endpoint in the Monitoring tab — we probe every 10 minutes from the edge and record latency + status. Public projects get a `/status/<slug>` page customers can bookmark and share during incidents. 14 days of history, no extra plan tier.
Can I embed an interactive demo on my marketing site?
Yes. Drop one `<script src="https://docs.outworx.io/widget.js" async></script>` tag plus a `<div data-outworx-embed="try-it" data-slug="…" data-operation-id="…">` and visitors can run the endpoint right from your blog post or landing page. Lazy-loaded iframe, no React or Vue dependency.
Do you have a Postman alternative built in?
Yes — the Collections tab. Save common requests with method + path + headers + body, reference `{{baseUrl}}` and `{{apiKey}}` placeholders, and flip between staging and production environments with one click. No separate desktop app, no syncing, no team-tier pricing.
Plans & teams
Is there a free plan?
Yes. Free gets 2 projects, hosted docs at yourapi.docs.outworx.io, the full Try It playground, code snippets in 4+ languages, and 5 AI searches per month. No credit card required.
Can I invite my teammates?
Yes. Pro includes 3 collaborator seats, Business includes 10. Invite by email — your teammate signs in with the invited address and gets full access to your projects: upload specs, edit settings, manage versions, regenerate MCP and upload tokens, view analytics and chat activity. Only two things stay owner-only: deleting a project and managing billing. Seats can be removed at any time; removed teammates lose access immediately.
What makes Outworx different from ReadMe or Mintlify?
Price, scope, and AI-native. Pro is $9/mo (vs $99+ at ReadMe, $150+ at Mintlify) and replaces 5 separate tools — docs (Mintlify), SDKs (Speakeasy), spec diffs (Bump.sh), uptime (Checkly), API client (Postman). Upload your spec and the entire lifecycle is live in under a minute. And you're the only docs platform that ships a per-project MCP server.