What is Reqbook?
Reqbook is the notebook for API workflows. It stores API docs, requests, tests, flows, and coding-agent context as runnable Markdown files in your repository.
FAQ
Reqbook FAQ
Answers about Reqbook, the notebook for API workflows: Markdown API specs, local-first installs, CI, agents, imports, secrets, and comparisons.
Common questions
Why call Reqbook an API workflow notebook?
Because each Markdown spec can explain the endpoint, define the request, show the expected response, capture variables, run assertions, and give agents compact executable context.
How is Reqbook different from Postman, Bruno, or Insomnia?
Those tools are strongest as API clients and collection workspaces. Reqbook is strongest when the API source of truth should live in Git, run in CI, and stay readable to coding agents.
Do I need an account?
No. Reqbook runs locally as a Rust binary. There is no hosted workspace or login. Optional anonymous active-usage reporting is off by default.
How do I install Reqbook?
Use the shell installer, npm package, crates.io package, VS Code extension, Homebrew tap, Windows installer, Docker image, or a source checkout.
Does Reqbook work with coding agents?
Yes. Reqbook ships agent skills and MCP tools so Claude Code, Cursor, Copilot, Codex, Antigravity, Windsurf, and OpenCode can read, run, validate, and update API specs.
Can Reqbook run in CI?
Yes. Use rqb validate for spec checks, rqb exec for endpoint execution, and rqb flow for multi-step API workflows.
Can I import existing API definitions?
Yes. Reqbook can import from OpenAPI, cURL, Postman, Insomnia, local client collections, .http files, or scan a project for missing specs.
How are secrets handled?
Keep secrets out of committed Markdown. Use local env files, CI secrets, or RQB_* environment variables while committing templates and non-secret variable names.
Recommended next steps
Install
Start with the Reqbook install guide and open the browser workspace with rqb serve.
Compare
Read Reqbook vs Postman if you are moving from a hosted collection workflow.
Agents
Use Claude Code or Cursor guides when agents need API context.