From 0b12c8e0e3920c17e8f654d2179007d57f6c6a29 Mon Sep 17 00:00:00 2001
From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com>
Date: Mon, 16 Mar 2026 11:57:57 +0000
Subject: [PATCH] Add request examples documentation page
Generated-By: mintlify-agent
---
docs.json | 1 +
general/api-client/examples.mdx | 95 +++++++++++++++++++++++++++++++++
2 files changed, 96 insertions(+)
create mode 100644 general/api-client/examples.mdx
diff --git a/docs.json b/docs.json
index 4acf259..7ad5f68 100644
--- a/docs.json
+++ b/docs.json
@@ -83,6 +83,7 @@
"pages": [
"general/api-client/design-apis",
"general/api-client/api-collections",
+ "general/api-client/examples",
{
"group": "Import & Export APIs",
"pages": [
diff --git a/general/api-client/examples.mdx b/general/api-client/examples.mdx
new file mode 100644
index 0000000..8101a7a
--- /dev/null
+++ b/general/api-client/examples.mdx
@@ -0,0 +1,95 @@
+---
+title: "Request Examples"
+label: "Request Examples"
+slug: "examples"
+description: "Save, manage, and reuse request examples in Requestly's API Client. Create snapshots of your API requests with different configurations for quick reuse."
+seoTitle: "Request Examples"
+seoDescription: "Save, manage, and reuse request examples in Requestly's API Client. Create snapshots of your API requests with different configurations for quick reuse."
+visibility: "PUBLIC"
+---
+
+---
+
+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.
+
+
+
+ Navigate to an existing API request in your workspace or send a new request.
+
+
+ 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.
+
+
+ The example opens in a new tab. The parent request in the sidebar expands to show the newly created example beneath it.
+
+
+
+
+ You can also save examples from the request's context menu in the sidebar by right-clicking the request and selecting the save option.
+
+
+## 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.
+
+
+ Deleting an example is permanent and cannot be undone.
+
+
+## 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?
+
+
+
+ Organize your requests into collections and folders
+
+
+ Use variables to make requests reusable across environments
+
+
+ Add pre-request scripts and tests to automate your workflow
+
+