Requests
Requests
Build HTTP requests with any method, headers, body and settings.
Overview
A request is everything Relay needs to call an endpoint: a method and URL, query parameters, headers, a body, authentication, scripts and settings. The request editor puts each of these on its own tab, and any field can contain variables that Relay fills in when you send.
Requests are either drafts, which are quick and unsaved, or part of a collection in a workspace. Either kind can be sent, duplicated and turned into the other.
Topics
Essentials
- Creating and managing requests: Keep requests as drafts or save them in collections, and rename, duplicate and open them in their own windows.
- Setting the method and URL: Choose a standard or custom HTTP method and build the URL and its query parameters.
- Adding headers: Send headers with a request and control which ones are included.
- Adding a request body: Send text, JSON, form fields or files with a request.
GraphQL
- Sending GraphQL queries: Write GraphQL operations with schema-aware completion and send them with variables.
Configuration and documentation
- Configuring request settings: Set the timeout, redirect behavior, proxy and certificate checks for a request or a group of requests.
- Documenting requests: Describe what a request does with a summary, Markdown notes and reference links.
Sending
- Sending, stopping, and replaying requests: Send a request, stop one that's in progress and send a past request again.
See Also
- Inspecting responses: Read a response's status, body and headers, and copy or save what you need.
- Using variables: Insert values into requests with
{{name}}tokens and see where each value comes from. - Inheriting authentication: Set authentication once on a workspace, collection or folder and let requests inherit it.