Question 1

What API spec formats are supported?

Accepted Answer

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.

Question 2

Is there a free plan?

Accepted Answer

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.

Question 3

Can I use my own domain?

Accepted Answer

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.

Question 4

How does auto-sync keep my docs current?

Accepted Answer

Point at your spec URL and Outworx re-fetches on an hourly, daily, or weekly schedule. Your hosted docs always match what's live — no redeploys or manual updates needed.

Question 5

Can I test localhost APIs?

Accepted Answer

Yes. Run `npx @outworx/proxy` in your terminal and the Try It playground routes requests to your local dev server, bypassing browser CORS restrictions. Works with HTTPS and self-signed certs too.

Question 6

What is the MCP server and who uses it?

Accepted Answer

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.

Question 7

How does the AI chat on my docs work?

Accepted Answer

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.

Question 8

How do descriptions, code examples, and search work?

Accepted Answer

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.

Question 9

Does Outworx ship a hosted mock server?

Accepted Answer

Yes. Every public, non-password-protected project gets a free hosted mock URL the moment its spec uploads — `docs.outworx.io/mock//...` for OpenAPI/Swagger, and POST `/mock//graphql` for GraphQL specs. Responses come from explicit `example` fields in your spec, named examples cycled via the standard `Prefer: example=` 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.

Question 10

Can I customize mock responses without changing my spec?

Accepted Answer

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.

Question 11

Can the mock server validate requests or enforce auth?

Accepted Answer

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.

Question 12

What plan limits apply to the mock server?

Accepted Answer

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.

Question 13

Can Outworx capture and replay webhooks?

Accepted Answer

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.

Question 14

Can I lock a webhook inbox down for production traffic?

Accepted Answer

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.

Question 15

How does the Try It playground work?

Accepted Answer

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.

Question 16

Do you generate SDKs from my spec?

Accepted Answer

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.

Question 17

Can Outworx detect breaking changes in my spec on PRs?

Accepted Answer

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.

Question 18

Do you offer uptime monitoring and a status page?

Accepted Answer

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.

Question 19

Can I embed an interactive demo on my marketing site?

Accepted Answer

Yes. Drop one `` tag plus a `

` and visitors can run the endpoint right from your blog post or landing page. Lazy-loaded iframe, no React or Vue dependency.

Question 20

Do you have a Postman alternative built in?

Accepted Answer

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.

Question 21

Can I invite my teammates?

Accepted Answer

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.

Question 22

Can I restrict what teammates can edit?

Accepted Answer

Yes — Business plan unlocks two-layer RBAC. Set an account-wide default role (editor / viewer / none) for new collaborators, then override per project from the Access tab. Editors can do everything except billing, deleting projects, and managing roles; viewers are read-only; "none" hides a specific project from a teammate who otherwise has account-wide access. Pro and Free flatten every active collaborator to editor for back-compat, but stored overrides survive a downgrade — re-upgrade restores the permission map without a re-pick.

Question 23

Do you have an audit log for SOC2?

Accepted Answer

Yes — Business plan ships a full audit pipeline. Every dashboard mutation and v1 API call writes a row with a stable UPPER_SNAKE action code, the actor, the project, and a dashboard / api / system source. Filter on /settings/activity by date range, actor, project, or category; CSV export for evidence dumps. Pipe the same stream into your SIEM via an HMAC-SHA256-signed webhook (Datadog Logs, Splunk HEC, Honeycomb). Per-account retention is configurable from 30 days to 10 years — default 730 days covers SOC2 Type II.

Question 24

Can I push specs from CI?

Accepted Answer

Yes. Install `@outworx/cli` from npm and run `outworx push openapi.yaml --project <slug>` from any CI runner with Node 20+. Zero deps, ~30KB tarball, instant `npx` cold-start. For GitHub-hosted runners we ship `outworx/upload-spec-action@v1` — three lines in your workflow YAML. Token-prefix routing covers both account-level personal access tokens (preview pushes work) and per-project upload tokens. Exit codes are scriptable: 0 success / 1 user error / 2 transient / 3 internal.

Question 25

Do PR previews give my reviewers a clickable docs URL?

Accepted Answer

Yes — Pro and Business plans support PR preview deploys. Pass `--preview --pr 247 --commit $GITHUB_SHA --branch $GITHUB_HEAD_REF` to the CLI (or the Action's `preview: true` input) and Outworx publishes a throwaway version at `//preview/`. The preview renders an amber banner with the PR / branch / commit, expires in 14 days (rolling — every push pushes the TTL forward), and stays hidden from the public version dropdown until you merge. Stale PRs prune themselves via pg_cron.

Question 26

What makes Outworx different from ReadMe or Mintlify?

Accepted Answer

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.

Question 27

Can I customize my docs page like I would in Mintlify?

Accepted Answer

Yes — Pro and Business plans get a docs page builder. Replace the default top bar with your own logo, custom title, CTA buttons (e.g. “Sign up”, “GitHub”), plain-text links, and an optional top-bar search input. For each endpoint you can also add a markdown intro that renders above the auto-generated parameters/responses and an extras block that renders below the Try-It panel — same idea as a Mintlify MDX endpoint page, no scaffolding required. Edit everything from the dashboard's Customize tab with live preview.

Question 28

Can I remove the “Powered by Outworx Docs” footer?

Accepted Answer

Yes, on Pro and Business. Free-plan docs always show the badge in the sidebar footer. Pro and Business projects keep the badge by default but can flip a single toggle in the Customize tab to remove it for a fully white-labeled docs page. If you downgrade later, your saved customizations stay in the database for 14 days so re-subscribing inside the window restores everything — only after that does our retention cron hard-delete the rows.

CompareEvery featureMonthly headline · yearly is 10× the monthly price (2 mo free).	Free $0/ forever Dogfood your own API, forever. Start free	Most popular Pro $9/ mo or $90/yr · 2 mo free When the first customer asks for docs. Upgrade to Pro	Business $19/ mo or $190/yr · 2 mo free Public API, real traffic, real compliance. Upgrade to Business
Limits
Projects	2	10	Unlimited
Versions per project	1	3	Unlimited
Collaborator seats		3	10
Docs
Hosted public docs URL
Try It playground + code snippets
Docs page builder · per-endpoint markdown
Custom branding · password protection
Custom domain + auto-SSL
AI · MCP
AI-powered search	5 / mo	Unlimited	Unlimited
AI chat on docs		25k tok/day	200k tok/day
MCP server per project (Claude / Cursor / Cline)
Mock server
Requests / month	10k	100k	Unlimited
Stateful overrides	5	25	50
Chaos mode · import/export
API platform
SDKs (TypeScript + Python)
Spec diff + GitHub PR Action
Uptime monitoring
Saved requests · environments
Embeddable Try-It widget
PR preview deploys (active)		5	20
Webhooks
Inboxes	5	25	Unlimited
Captures · retention	500	10k / 30d	Unlimited / 90d
Governance
Two-layer RBAC (account + project)
Audit log + HMAC-signed SIEM webhook
Configurable retention (30d → 10y)
Analytics dashboard
Priority support

Team	Outworx	Per-seat platform
3 people	$9 /mo	$60–$120 /mo
5 people	$19 /mo	$100–$200 /mo
10 people	$19 /mo	$200–$400 /mo
20 people	$19 /mo	$400+ /mo

Flat pricing. No per-seat tax.

Everything inside each plan.

Per-seat billing punishes you for growing.

Frequently asked questions.

Replace your API stack with one upload.