Getting Started

Welcome to the ForgeReq usage guide. This documentation will walk you through the core features of the application.

Overview

ForgeReq is a privacy-first, local-only REST API workbench. Every endpoint, secret, and response stays on your machine inside an AES-256-GCM encrypted vault.

What’s inside

• 🌟 AI Assistant — bring-your-own-key chat sidebar that autonomously drives the workspace for you.

• The Workbench — build, send, and inspect requests across HTTP, gRPC, Kafka, and SOAP.

• Stash & Realms — variables and environment overlays, all encrypted at rest.

• Request Chaining (Rules) — declarative response → variable capture, library-scoped.

• Inheritance & Overrides — cascade auth, headers, and proxy down library → shelf → endpoint.

• Local Mock Servers — expose any library as a localhost HTTP mock in one click.

• gRPC · Kafka · SOAP — first-class support for each protocol.

• Library Runner & Load Testing — sequence runs and parallel load tests with live percentiles.

• Client Certificates (mTLS) — global cert registry, PEM and PFX, passphrase-aware, proxy-friendly.

• Vault Backup — portable, passphrase-protected .rfvault export / import.

✨ Brand New: Agentic AI Assistant

ForgeReq now includes a powerful, built-in AI Assistant that can drive your workspace directly from natural language.

• Provide your own API key (OpenAI, Anthropic, Gemini, Grok, Azure, Ollama, etc.)
• Tell the AI to “create a new login request”, “add auth headers”, or “run a load test”.
• The AI creates, updates, and executes requests autonomously on your behalf.

Use the sidebar on the left to jump into any guide.