Recipes
Step-by-step walkthroughs for real-world scenarios on the Zerq platform. Each recipe covers a complete, working configuration — from prerequisites through verification.
Gateway & access control
These recipes cover configuring collections, proxies, clients, and profiles to support real-world access patterns.
| Recipe | What you build |
|---|---|
| Partner API Onboarding | Create a client, profile, and portal access for a B2B partner end-to-end |
| Tiered API Monetization | Define Free, Pro, and Enterprise tiers with separate rate limits and quota enforcement |
Workflow patterns
These recipes cover common workflow designs built with the Zerq workflow canvas.
| Recipe | What you build |
|---|---|
| Backend Aggregation | Combine responses from two upstream services into a single API response |
| Canary Routing | Route a percentage of traffic to a new backend, leaving the remainder on the stable path |
| Retry and Fallback | Retry a flaky backend up to three times, then serve a static fallback response |
| Request/Response Transformation | Strip, rename, and inject fields in a request or response without changing the backend |
AI and automation
These recipes cover giving AI clients access to your APIs and automating platform management.
| Recipe | What you build |
|---|---|
| AI Agent Access via Gateway MCP | Configure a Cursor or Claude client to discover and call your APIs through Gateway MCP |
| Gateway + Management MCP Together | Use both MCP surfaces in one agent: configure with Management MCP, test with Gateway MCP |
| CI/CD Platform Automation | Create and update collections, proxies, and workflows from a CI/CD pipeline via Management MCP |
How recipes are structured
Every recipe follows this pattern:
- Overview — What the recipe builds and why it is useful
- Prerequisites — What must already exist before you start
- Steps — Numbered instructions following the platform UI
- Verify — How to confirm the configuration works
- Next steps — Where to go from here