Request examples let you save snapshots of an API request with specific configurations—such as different parameters, headers, or body payloads—so you can quickly switch between variations without modifying the original request. Examples are stored as children of their parent request and appear in the sidebar for easy access.
Why use examples
- Test multiple scenarios — Save different request configurations (valid input, edge cases, error states) and switch between them instantly.
- Share context with your team — Examples sync with your workspace so team members can see the exact request configurations you used.
- Preserve response data — Each example captures the request and response together, making it easy to revisit past results.
Save a request as an example
You can create an example from any HTTP or GraphQL request that has been sent at least once.Save as example
Click the Save dropdown button in the request view and select Save as Example. The current request configuration—including URL, method, headers, parameters, and body—is saved as a new example under that request.
Manage examples in the sidebar
Examples appear as collapsible children under their parent request in the sidebar. Click the expand arrow next to any request to reveal its examples.Open an example
Click on an example in the sidebar to open it in a new tab. The example loads with the saved request configuration and response data.Rename an example
Right-click the example in the sidebar and select Rename, or double-click the example name. Type the new name and press Enter to save.Duplicate an example
Right-click the example in the sidebar and select Duplicate. A copy of the example is created under the same parent request.Reorder examples
Drag and drop examples within the same parent request to reorder them. The new order is persisted automatically.Delete an example
Right-click the example in the sidebar and select Delete. Confirm the action in the prompt that appears.Use an example as a template
When viewing an example, click Use as Template to load its configuration into a new draft request. This lets you start a new request based on an existing example without modifying the original.Duplicating requests with examples
When you duplicate an API request that has examples, all associated examples are duplicated along with it. Each duplicated example retains the original’s configuration but is linked to the new request copy.How examples are stored
- Examples are stored as separate records linked to their parent request via a
parentRequestId. - Scripts (pre-request and post-response) and authorization settings are not carried over to examples. Each example stores only the request configuration and response data.
- Examples sync across your team workspace, just like requests and collections.
What’s next?
API Collections
Organize your requests into collections and folders
Variables
Use variables to make requests reusable across environments
Scripts & Tests
Add pre-request scripts and tests to automate your workflow