Configuring Relay settings
Change Relay's defaults for requests, networking, history, code export and the MCP server.
Overview
Relay's settings hold the choices that apply across all your workspaces: how Relay looks, how requests are sent unless they say otherwise, how much history Relay keeps, the code generators it offers and its MCP server. To open them, choose Relay > Settings or press Command-Comma, then click a pane in the sidebar. Changes take effect right away.
The request and network settings are defaults. A workspace, collection, folder or request can override them in its own Settings tab. For how those levels combine, see Configuring request settings.
General
| Setting | What it does | Default |
|---|---|---|
| Appearance | Shows Relay light, dark, or matching the system with Auto. | Dark |
| Light Theme or Dark Theme | The colors of Relay's main windows in the current appearance. | System |
| Syntax Highlighting | The colors of code in Relay. | Relay |
| Reset Onboarding | Click Reset to show the Getting Started screen the next time Relay opens. | — |
For more about themes, see Choosing themes.
Requests
| Setting | What it does | Default |
|---|---|---|
| Default Method | The method new requests and drafts start with. | GET |
| Default Timeout | How many seconds a request waits for the server before it fails, from 1 to 3600. | 30 seconds |
| Streaming Idle Timeout | How many seconds an event stream can go without sending anything before it ends, from 1 to 86,400. | 300 seconds |
| Script Timeout | How many seconds each script phase can run, including its timers and the requests it sends, from 1 to 300. | 30 seconds |
| Use Default User Agent | Adds a User-Agent header to requests that don't set one. | On |
| User Agent | The value of that header. | Relay |
| Delete All Drafts | Click Delete… to remove every draft. | — |
When you click Delete…, Relay asks you to confirm. Click Delete Drafts to remove them all.
Network
| Setting | What it does | Default |
|---|---|---|
| Proxy | System Settings uses the proxy set in System Settings. No Proxy connects directly. Custom sends requests through the proxy you describe below. | System Settings |
| Type | For a custom proxy, HTTP or SOCKS5. | HTTP |
| Server | For a custom proxy, its host and port. | Port 8080 |
| Username and Password | For a custom proxy that needs them. The password is kept in your keychain. | — |
| Bypass Proxy For | Hosts that connect directly, separated by commas. | — |
| Follow Redirects | Follows redirect responses to their new location. | On |
| Maximum Redirects | The most redirects a request follows before it fails, from 1 to 50. | 10 |
| Follow Original Method | Repeats the method and body after a 301 or 302 instead of switching to GET. | Off |
| Keep Authorization Across Origins | Sends the Authorization header when a redirect leads to another host, scheme or port. | Off |
| Verify Certificates | Fails requests when the server's TLS certificate isn't trusted. | On |
For details, see Routing requests through a proxy and Following redirects.
History
| Setting | What it does | Default |
|---|---|---|
| Max History Entries | How many sent requests Relay keeps in History, from 10 to 500 in steps of 10. Lowering it removes the oldest entries right away. | 100 |
| Clear All History | Click Clear… to remove every history entry. | — |
When you click Clear…, Relay asks you to confirm. Click Clear History to remove them all.
Important
Exporters
The Exporters pane lists the code generators the Preview panel offers, in an HTTP section and a WebSocket section. Generators you've created are marked Custom. Select a generator to see its JavaScript source in the editor beside the list.
- To create a generator, click the Add button (+) and choose New HTTP Generator or New WebSocket Generator.
- To copy a generator as a starting point for your own, select it and click the Duplicate Generator button.
- To change a generator, edit its source and click Save, or press Command-S. Click Revert to discard your changes. Saving a built-in generator saves your copy, which replaces it in the Preview panel.
- To delete a generator you created, select it and click the Delete Generator button (−). Deleting your copy of a built-in generator brings the built-in one back. Built-in generators can't be deleted.
- To see the files of your generators, click the Reveal in Finder button.
For more, see Creating a custom code generator.
MCP
| Setting | What it does | Default |
|---|---|---|
| Enable MCP Server | Runs Relay's MCP server so AI agents can connect. | Off |
| Port | The port the server listens on, from 1024 to 65535. Click Apply after you change it. | 47823 |
| Status | Whether the server is stopped, starting or running, or why it couldn't start. Click Retry to try again. | — |
| Authentication | The token agents use to connect. Show or hide it, copy it, or click Regenerate… to replace it. | — |
| Reveal Credentials in Generated Code | Lets code that agents generate with generate_code hold your real credentials, cookies and variable values. When it's off, the code keeps {{name}} tokens and shows placeholders for credentials. | Off |
| Client Configuration | The setup for Claude Code and for agents configured with JSON, ready to copy. | — |
For setup steps, see Connecting an AI agent to Relay.
Edit the defaults from the Workspaces window
The Globals Settings tab in the Workspaces window edits the same request timeout, streaming idle timeout, script timeout, redirect, certificate and proxy defaults as the Requests and Network panes. A change in either place shows in the other. To open it, choose Edit Workspaces… from the workspace menu, select Globals, then click Settings.
See Also
- Choosing themes: Pick Relay's appearance, its light and dark themes and a syntax-highlighting theme.
- Configuring request settings: Set the timeout, redirect behavior, proxy and certificate checks for a request or a group of requests.
- Reviewing request history: Look back at requests you've sent, replay them and turn them into new drafts.
- Generating code from requests: Turn a request into code for curl, Python, JavaScript, Swift and other languages.