Introduction
Build, send and test HTTP, GraphQL, event-stream and WebSocket requests with Relay.
Overview
Relay is a fast, beautiful, native API client for macOS. Build requests by hand in the editor or with the help of an agent, then inspect responses and debug API endpoints and URLs with built-in response tools. Organize requests into collections, fill them in with variables and environment settings, and test or modify the results with scripts.
You can import existing APIs or request collections from OpenAPI, Postman or cURL and export any request as code in more than a dozen languages. Agents can work with your requests, write custom exporters and modify settings through Relay's local MCP server.
Topics
Essentials
- Essentials: Install Relay, learn its window and send your first request.
Building and sending requests
- Requests: Build HTTP requests with any method, headers, body and settings.
- Responses: Read response bodies, headers and timing, and look back through your history.
- WebSockets: Open WebSocket connections and exchange messages with a server.
Organizing your work
- Workspaces and Collections: Group requests into workspaces, collections and folders, and keep them in files you can share.
- Variables and Environments: Reuse values across requests and switch between environments.
Security and networking
- Authentication: Authorize requests with tokens, keys, OAuth and signatures, set once and inherited.
- Networking: Control cookies, redirects, proxies and TLS certificates.
Automation
- Scripts: Run JavaScript before and after requests to prepare data and test responses.
- Import and Export: Bring in APIs from OpenAPI, Postman and cURL, and turn requests into code.
- AI Agents: Let coding agents read and create requests through Relay's MCP server.
Customization
- Customization: Choose themes and change Relay's settings.
Reference
- Keyboard shortcuts: The keyboard shortcuts for Relay's commands.
- Scripting API: The objects and functions available to request scripts.
- Code Generator API: The manifest, request model and helpers for writing code generators.
- MCP Tools: The tools Relay's MCP server offers to AI agents.
- Dynamic variables: Dynamic variables that generate a new value each time a request is sent.
- Workspace file format: The folders and JSON documents that store a workspace.
- Supported formats: The import formats, body types, auth types and limits Relay supports.