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

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 3

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 4

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 5

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 6

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 7

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 8

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 9

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 10

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 11

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 12

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 13

What makes Outworx different from ReadMe or Mintlify?

Accepted Answer

Price, speed, and AI-native. Pro is $9/mo (vs $99+ at ReadMe, $150+ at Mintlify). Upload your spec and your docs are live in under a minute — no config files, no build pipelines, no plugins. And you're the only docs platform that ships a per-project MCP server, so the AI tools your users are already using can operate your API natively.

Simple pricing.

Simple, honest pricing

Free

Pro

Business

Frequently asked questions

Stop answering the same API questions.