Start
Overview
API Twin is a hosted mock of the APIs your tests call. A twin answers HTTP in place of a service that is metered, unfinished, or awkward to run in CI.
A workspace holds people, the plan, and the twins. A twin is one mock API, with its own invoke URL, routes, state, and scenario. A route is one response rule: method, path, matchers, status, and body.
What you can simulate
- REST, including a stateful collection that remembers records across calls.
- OpenAI-compatible chat, including SSE and tool calls.
- gRPC as unary JSON, GraphQL by operation name, and SOAP by action or body element.
- WebSocket and Kafka-style topics on the local socket hub.
- Faults: Normal, Degraded, and Outage, plus delay, error rate, and a per-minute cap.
How a call gets in
Public twins answer /sim/{slug}/... with no login. Private twins need a workspace API key. On Developer and above, the same twin also answers https://{slug}.apitwin.dev/....
Start with the first-twin tutorial, then the orders tutorial if the service you are replacing has to remember what was posted.