Getting started with Relay
Learn the parts of Relay's window and how they work together.
Overview
Relay runs on macOS 26 or later. The first time you open it, the Getting Started screen walks you through choosing an appearance, connecting an AI agent and importing an existing API. You can skip any step and come back to it later. To see the screen again, choose Help > Show Getting Started.
Each Relay window shows one workspace and has three panes: the sidebar, the request editor and the response inspector. You select a request in the sidebar, edit it in the request editor and send it, and the response appears in the inspector.
Find your requests in the sidebar
The sidebar lists the window's workspace and the requests you're working on:
- Collections: The workspace's collections, the folders inside them and their requests. A collection groups requests that belong together, such as the endpoints of one API.
- Drafts: Requests you haven't saved to a collection yet. A new request starts here.
- History: The requests you've sent, newest first. Click Show More at the end of the list to see older ones.
Drafts and history are shared by every window, whatever workspace it shows.
The workspace menu at the top of the sidebar shows the workspace's name. Use it to switch workspaces, choose the active environment, create or open a workspace and edit workspace settings.
At the bottom of the sidebar, click the Add button (+) to create a draft or collection or to import requests. Enter text in the Filter field to show only matching requests.
To act on an item in the sidebar, Control-click it. Collections and folders offer commands to add requests and folders and to edit their variables, auth and scripts. Requests offer commands to rename, duplicate, move or delete them, or to open them in a new window.
Build a request in the request editor
The request editor shows the request that's selected in the sidebar. At the top, the URL bar holds the method, the URL and the Send button. Below it, tabs organize the rest of the request:
| Tab | Shortcut | Contents |
|---|---|---|
| Documentation | ⌘1 | A summary and Markdown notes about the request. |
| Params | ⌘2 | The URL's query parameters. |
| Auth | ⌘3 | How the request is authenticated. |
| Headers | ⌘4 | The request's headers. |
| Body | ⌘5 | The request's body. For a WebSocket request, this tab is Messages. |
| Scripts | ⌘6 | JavaScript that runs before and after the request. |
| Settings | ⌘7 | The timeout, redirect, proxy and certificate settings. |
You can also choose a tab from View > Jump to.
The bar at the bottom of the request editor shows the request's method and URL. Click them to open the Preview panel, which shows the request as raw HTTP or as code in another language. The bar's Variables button lists every variable the request can use. Its Environments button switches the active environment.
Read the response in the response inspector
The response inspector shows the latest response to the selected request. Its status, such as 200 OK, appears at the top, and its tabs show the details:
- Body: The response body. JSON and HTML are formatted for reading, and images are previewed.
- Events: The events of a server-sent event stream, or the messages of a WebSocket connection. This tab appears only for those responses.
- Headers: The headers Relay sent and the headers the server returned.
- Timeline: How long each stage of the request took.
- Tests: The results of tests and the console output of the request's scripts.
Work in several windows and tabs
To open another window, choose File > New Window or press Command-N. To open a tab in the current window, choose File > New Tab or press Command-T. A new window or tab starts on the same workspace as the one it was opened from, and you can switch it to any other workspace. Each window keeps its own selection, so you can view two workspaces side by side.
To give a request a window of its own, Control-click it in the sidebar and choose Open in New Window.
See Also
- Sending your first request: Create a draft, send it, read the response and save the request.
- Understanding workspaces: Learn how workspaces, collections, folders and drafts fit together.
- Keyboard shortcuts: The keyboard shortcuts for Relay's commands.