Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
414 changes: 414 additions & 0 deletions .cursor/rules.mdc

Large diffs are not rendered by default.

36 changes: 18 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,15 +19,14 @@

## 📖 About

This repository contains the official documentation for [Requestly](https://requestly.com) - a powerful tool for API Mocking, Testing, and Debugging. The documentation covers:
This repository contains the official documentation for [Requestly](https://requestly.com), organized around the main jobs users come to Requestly to do:

- **Browser Extension** - HTTP interception and modification for Chrome, Firefox, Edge, and more
- **Desktop App** - Advanced debugging for mobile apps, desktop software, and simulators
- **API Client** - Modern API client for designing, testing, and managing APIs
- **HTTP Rules** - Comprehensive guides for modifying requests and responses
- **Mock Server** - API mocking and response simulation
- **Team Collaboration** - Workspace management and team features
- **Public APIs** - Programmatic access to Requestly features
- **API Testing** - Send requests, manage environments, organize collections, and add assertions
- **Debugging & Interception** - Inspect traffic from browsers, mobile apps, desktop apps, emulators, and runtimes
- **Modify Traffic** - Rewrite headers, bodies, query params, redirects, and delays without changing application code
- **Mock APIs & Responses** - Create quick mocks and reusable hosted mock endpoints
- **Sessions & Collaboration** - Record bug reports, capture API sessions, and share workflows with your team
- **Public APIs** - Automate Requestly workflows programmatically

## 🚀 Getting Started

Expand Down Expand Up @@ -62,16 +61,17 @@ The documentation will be available at `http://localhost:3000`
```
requestly-docs/
├── changelogs/ # Release notes and changelogs
├── general/ # General documentation
│ ├── getting-started/ # Getting started guides
│ ├── api-client/ # API Client documentation
│ ├── http-rules/ # HTTP Rules guides
│ ├── mock-server/ # Mock Server documentation
│ ├── sessions/ # Session recording docs
│ └── team/ # Team & collaboration features
├── guides/ # How-to guides and tutorials
├── public-apis/ # Public API documentation
├── troubleshoot/ # Troubleshooting guides
├── general/ # Core product docs and onboarding
│ ├── getting-started/ # Intro, setup, and quick-start flows
│ ├── api-client/ # API testing workflows
│ ├── http-rules/ # Traffic modification workflows
│ ├── http-interceptor/# Traffic inspection and interception workflows
│ ├── mock-server/ # Hosted mocks and response simulation
│ ├── sessions/ # Bug reports, API sessions, and HAR workflows
│ └── team/ # Collaboration and workspaces
├── guides/ # Task-based guides and integration tutorials
├── public-apis/ # Programmatic Requestly APIs
├── troubleshoot/ # Setup and workflow recovery guides
├── images/ # Image assets
├── docs.json # Mintlify configuration
└── LICENSE # License file
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
---
***

Efficient license management is essential for seamless operations. Requestly allows organizations to effortlessly manage their subscriptions and licenses.

Check warning on line 12 in account/billing-subscriptions.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestly) - vale-spellcheck

account/billing-subscriptions.mdx#L12

Did you really mean 'Requestly'?

### Role Overview

Expand Down Expand Up @@ -99,7 +99,7 @@
Select a user from the list of available members and click **Assign**.

<Tip>
If the user is not listed, use the **Invite & Assign License** option. Enter the user’s email to send an invitation. Once the user signs up, he will be automatcially assigned a license.
If the user is not listed, use the **Invite & Assign License** option. Enter the user’s email to send an invitation. Once the user signs up, they will be automatically assigned a license.
</Tip>

<img src="/images/billing-subscriptions/fbc7123f-4854-4ae0-b357-2084b524d26d.png" align="center" fullwidth="false" />
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: How is the Browser Extension Different from the Desktop App
label: Browser Extension vs Desktop App
slug: how-is-bowser-extension-different-from-a-desktop-app
slug: how-is-browser-extension-different-from-a-desktop-app
visibility: PUBLIC
---
Requestly is available as both a **browser extension** and a **desktop application**. While both platforms offer a similar set of features, their capabilities differ slightly to address platform-specific limitations and better cater to distinct use cases.

Check warning on line 7 in account/how-is-browser-extension-different-from-a-desktop-app.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestly) - vale-spellcheck

account/how-is-browser-extension-different-from-a-desktop-app.mdx#L7

Did you really mean 'Requestly'?

The **browser extension** is comparatively a **lighter tool** that runs directly within the browsers and is ideal for **browser-focused workflows**. The **desktop app** is designed to provide more control over network traffic across the **entire system**, including apps outside the browser. This comparison outlines functional differences to help you choose the right setup for your use case.

Expand All @@ -29,7 +29,7 @@

## HTTP Rules

| **Feature** | **Browser Extention** | **Desktop App** |

Check warning on line 32 in account/how-is-browser-extension-different-from-a-desktop-app.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestly) - vale-spellcheck

account/how-is-browser-extension-different-from-a-desktop-app.mdx#L32

Did you really mean 'Extention'?
| --------------------------- | ------------------------------------------------------ | --------------- |
| HTTP Rules | ✅ \[Limitations below]👇 | ✅ |
| Delay Rule max delay | 5000ms (Fetch/ XHR requests) 10000ms (Other resources) | Unlimited |
Expand All @@ -45,7 +45,7 @@

| **Feature** | **Browser Extension** | **Desktop App** |
| ---------------- | --------------------- | --------------- |
| Mock Server | ✅ | ✅ |
| File Server | ✅ | ✅ |
| Bulk Mocking | ❌ | ✅ |
| Session Book | ✅ | ❌ |
| Network Sessions | ❌ | ✅ |
Expand All @@ -61,7 +61,7 @@

## Visibility of Executed Rules

The way Requestly shows rule executions varies between the browser extension and desktop app, tailored to their respective environments:

Check warning on line 64 in account/how-is-browser-extension-different-from-a-desktop-app.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestly) - vale-spellcheck

account/how-is-browser-extension-different-from-a-desktop-app.mdx#L64

Did you really mean 'Requestly'?

<Tabs>
<Tab title="Browser Extension">
Expand Down
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "Generate API Test Cases using the Test Authoring Agent"
label: "Generate Test Cases using AI"
slug: "generate-test-cases-using-AI"
description: "Learn how to automatically author Post-response API test scripts using the Test Authoring Agent in Requestly. Use natural language instructions to create reliable, comprehensive API tests without manually writing JavaScript."

Check warning on line 5 in api-client/ai-test-generator.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestly) - vale-spellcheck

api-client/ai-test-generator.mdx#L5

Did you really mean 'Requestly'?
visibility: "PUBLIC"
---

Expand Down Expand Up @@ -92,7 +92,7 @@

## What the Test Authoring Agent Creates

The agent creates comprehensive test scripts using Requestly's [`rq.test`](/general/api-client/rq-api-reference/rq-test) and [`rq.expect`](/general/api-client/rq-api-reference/rq-expect) APIs with [Chai.js assertions](/general/api-client/tests#example-tests).
The agent creates comprehensive test scripts using Requestly's [`rq.test`](/api-client/rq-api-reference/rq-test) and [`rq.expect`](/api-client/rq-api-reference/rq-expect) APIs with [Chai.js assertions](/api-client/tests#example-tests).

Check warning on line 95 in api-client/ai-test-generator.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestly) - vale-spellcheck

api-client/ai-test-generator.mdx#L95

Did you really mean 'Requestly's'?

### Example Generated Tests

Expand Down Expand Up @@ -192,11 +192,11 @@
- **Debug**: Use `console.log()` in the script to debug test execution
- **Modify**: Edit the generated code directly if you need fine-grained control

See [Writing Tests](/general/api-client/tests) for more information about executing and debugging tests.
See [Writing Tests](/api-client/tests) for more information about executing and debugging tests.

## Related Topics

- [Writing Tests](/general/api-client/tests) - Learn about manual test writing and all available assertion methods
- [Scripts](/general/api-client/scripts) - Understand Pre-request and Post-response scripts
- [Collection Runner](/general/api-client/collection-runner) - Run multiple requests and tests in sequence
- [RQ API Reference](/general/api-client/rq-api-reference) - Full documentation of the `rq` object and its methods
- [Writing Tests](/api-client/tests) - Learn about manual test writing and all available assertion methods
- [Scripts](/api-client/scripts) - Understand Pre-request and Post-response scripts
- [Collection Runner](/api-client/collection-runner) - Run multiple requests and tests in sequence
- [RQ API Reference](/api-client/rq-api-reference) - Full documentation of the `rq` object and its methods
Original file line number Diff line number Diff line change
Expand Up @@ -93,12 +93,12 @@ Folders allow you to create sub-groups within a collection. They can have their

Collections include a **collection variables** feature that allows you to define and manage reusable values specific to the collection. Collection Variables are defined as key-value pairs that work as the base set of variables for collections. They can be used in API definitions with double curly braces `{{collection_variable}}`

Learn more about this feature on the [Variables](/general/api-client/environments-and-variables) page.
Learn more about this feature on the [Variables](/api-client/environments-and-variables) page.

## Collection Runner

The **Collection Runner** allows you to execute multiple API requests from a collection sequentially in a single run. It helps automate request workflows such as _login → create resource → fetch resource_ while utilizing existing variables and scripting capabilities.

Use it to configure iterations, delays, and environments, view detailed run results, debug failed requests, and export summaries for analysis.

Learn more about this feature on the [**Collection Runner**](https://docs.requestly.com/general/api-client/collection-runner) page.
Learn more about this feature on the [**Collection Runner**](https://docs.requestly.com/api-client/collection-runner) page.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
label: "Collection Runner"
slug: "collection-runner"
visibility: "PUBLIC"
seotitle: "Collection Runner - Requestly"

Check warning on line 6 in api-client/collection-runner.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestly) - vale-spellcheck

api-client/collection-runner.mdx#L6

Did you really mean 'Requestly'?
description: "Learn how to run collections, configure iterations, delays, and environments, reorder or skip requests, view and debug results, and export run summaries"
---

Expand Down Expand Up @@ -45,7 +45,7 @@
If you want your collection to run with an environment, select it using the environment selector at the upper left corner, then select the environment you want to use
</Step>
<Step title="Adjust Request Order or Skip">
You can drag to reorder requests or uncheck ones you don’t want to include in this run.

Check warning on line 48 in api-client/collection-runner.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestly) - vale-spellcheck

api-client/collection-runner.mdx#L48

Did you really mean 'uncheck'?

<img
src="/images/collection-runner/8652b545-82d1-4243-8a1c-5f77292f2806.gif"
Expand Down Expand Up @@ -108,4 +108,18 @@

- Request details - URL, headers, and body
- Response data - status, headers, and body
- The result of each test assertion
- The result of each test assertion

## What's Next?

<CardGroup cols={3}>
<Card title="Run with Data Files" icon="file-csv" href="/api-client/collection-runner-data-file">
Use CSV or JSON data files to parameterize collection runs across multiple inputs.
</Card>
<Card title="Write Tests" icon="flask" href="/api-client/tests">
Add assertions to validate response status, body, and headers on every run.
</Card>
<Card title="Use Variables" icon="brackets-curly" href="/api-client/environments-and-variables">
Set and modify variables dynamically during a run using pre/post scripts.
</Card>
</CardGroup>
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,19 @@
---
***

API builder in Requestly helps you define and organise your APIs with ease. You can further use these definitions to test APIs and develop your applications. This guide will walk you through the API Designing process within Requestly, which includes defining API Requests, managing APIs with collections, importing APIs, and using variables.

Check warning on line 12 in api-client/design-apis.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestly) - vale-spellcheck

api-client/design-apis.mdx#L12

Did you really mean 'Requestly'?

Check warning on line 12 in api-client/design-apis.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestly) - vale-spellcheck

api-client/design-apis.mdx#L12

Did you really mean 'Requestly'?

## API Builder

The **API Builder** in Requestly helps you design APIs, manage them using collections, and streamline workflows with variables. Let’s first explore the interface of the API Builder.

Check warning on line 16 in api-client/design-apis.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestly) - vale-spellcheck

api-client/design-apis.mdx#L16

Did you really mean 'Requestly'?

* To start creating APIs, click the `+ New` button at the top left of the API Builder. This provides three options:

* **API Request**: [Create a new API request](/general/api-client/make-an-api-request).
* **API Request**: [Create a new API request](/api-client/overview).

* **API Collection**: Organise multiple requests under [a collection](/general/api-client/api-collections).
* **API Collection**: Organise multiple requests under [a collection](/api-client/api-collections).

* **Environment**: [Define environment variables](/general/api-client/environments-and-variables) for testing and development.
* **Environment**: [Define environment variables](/api-client/environments-and-variables) for testing and development.

* The `Import` button allows you to import APIs from cURL, Requestly Collections, or Postman Collections.

Expand Down Expand Up @@ -63,7 +63,7 @@

**Step 6:** Save the request.

You can also enhance your API requests with **Scripts**, which allow you to [execute pre-request and post-response logic](/general/api-client/scripts) for custom workflows.
You can also enhance your API requests with **Scripts**, which allow you to [execute pre-request and post-response logic](/api-client/scripts) for custom workflows.

## Create API Collection

Expand All @@ -75,11 +75,11 @@

**Step 2:** Provide a descriptive name (e.g., “User Management APIs”) and press **Enter**.

For more details, refer to the [API Collections](/general/api-client/api-collections) section.
For more details, refer to the [API Collections](/api-client/api-collections) section.

## Import APIs & Collections

Requestly makes API design simple by allowing you to import APIs from various sources. This feature is invaluable for integrating existing workflows or migrating from other tools.

Check warning on line 82 in api-client/design-apis.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestly) - vale-spellcheck

api-client/design-apis.mdx#L82

Did you really mean 'Requestly'?

**Supported Imports:**

Expand All @@ -87,16 +87,16 @@

<img src="/images/design-apis/3d9d2d89-531b-47f6-b97b-7462888b3447.png" align="center" fullwidth="false" />

**Requestly API Collections:** Import existing collections from another Requestly account for continuity.

Check warning on line 90 in api-client/design-apis.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestly) - vale-spellcheck

api-client/design-apis.mdx#L90

Did you really mean 'Requestly'?

Check warning on line 90 in api-client/design-apis.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestly) - vale-spellcheck

api-client/design-apis.mdx#L90

Did you really mean 'Requestly'?

**Postman Collections:** Import APIs from Postman with 1-Click. Learn more about [Postman Imports](/general/api-client/migrate-from-postman).
**Postman Collections:** Import APIs from Postman with 1-Click. Learn more about [Postman Imports](/api-client/migrate-from-postman).

This flexibility ensures you can quickly set up your API workspace without starting from scratch.

## Variables in APIs

Requestly supports variables in two forms — **Collection Variables** and **Environment Variables**. Variables simplify managing repetitive or shared parts of APIs, such as base URLs or API keys. For example, multiple APIs can share the same base URL or authentication token.

Check warning on line 98 in api-client/design-apis.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestly) - vale-spellcheck

api-client/design-apis.mdx#L98

Did you really mean 'Requestly'?

Variables can be defined in environments and used in API requests by enclosing them in double curly braces, e.g., `{{base_url}}`.

Learn more about [Variables](/general/api-client/environments-and-variables) and how to use them effectively in your APIs.
Learn more about [Variables](/api-client/environments-and-variables) and how to use them effectively in your APIs.
Original file line number Diff line number Diff line change
Expand Up @@ -2,45 +2,45 @@
title: Variables and Environment
label: Variables and Environment
slug: environments-and-variables
description: ''
description: 'Learn how to use variables and environments in Requestly to manage dynamic values like API keys, base URLs, and tokens across your API requests.'

Check warning on line 5 in api-client/environments-and-variables.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestly) - vale-spellcheck

api-client/environments-and-variables.mdx#L5

Did you really mean 'Requestly'?
visibility: PUBLIC
---
Variables in Requestly’s API Client let you store and reuse dynamic values—like API keys, base URLs, and user IDs—across your API requests. They help you avoid hardcoding, make your collections more modular, and simplify switching between different environments like development, staging, and production.

Check warning on line 8 in api-client/environments-and-variables.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestly) - vale-spellcheck

api-client/environments-and-variables.mdx#L8

Did you really mean 'hardcoding'?

A **variable** is a named placeholder you define once and reference anywhere in your API collections using the `{{variable_name}}` syntax.

When you run a request, Requestly replaces each `{{variable}}` with its actual value based on its scope.

Check warning on line 12 in api-client/environments-and-variables.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestly) - vale-spellcheck

api-client/environments-and-variables.mdx#L12

Did you really mean 'Requestly'?

Example: `https://{{base_url}}/users/{{user_id}}`

If you've defined `base_url = api.example.com` and `user_id = 123`, the request resolves to - [`https://api.example.com/users/123`](https://api.example.com/users/123)
If you've defined `base_url = api.example.com` and `user_id = 123`, the request resolves to - `https://api.example.com/users/123`

<Tip>
+TIP: Hover over any `{{variable}}` in your request to preview its resolved value instantly.
</Tip>

### Explore Variable Types and Features

[Global Variables](/general/api-client/environments-and-variables/global-variables)
[Global Variables](/api-client/environments-and-variables/global-variables)

Use values that apply across all requests and collections.

[Environment Variables](/general/api-client/environments-and-variables/environment-variables)
[Environment Variables](/api-client/environments-and-variables/environment-variables)

Define values based on your working environment (e.g., dev, staging, prod).

[Runtime Variables](/general/api-client/environments-and-variables/runtime-variables)
[Runtime Variables](/api-client/environments-and-variables/runtime-variables)

Temporary values that last only for the current sessionideal for tokens or session IDs. They aren’t synced and can auto-clear after use.
Temporary values that last only for the current session, ideal for tokens or session IDs. They aren’t synced and can auto-clear after use.

[Collection & SubCollection Variables](/general/api-client/environments-and-variables/collection-and-subcollection-variables)
[Collection & SubCollection Variables](/api-client/environments-and-variables/collection-and-subcollection-variables)

Scope variables to specific collections or groups of requests.

[Variable Precedence](/general/api-client/environments-and-variables/variable-precedence)
[Variable Precedence](/api-client/environments-and-variables/variable-precedence)

Understand how Requestly resolves variable conflicts when the same name exists in multiple scopes.

Check warning on line 42 in api-client/environments-and-variables.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestly) - vale-spellcheck

api-client/environments-and-variables.mdx#L42

Did you really mean 'Requestly'?

[Using Variables in API Requests](/general/api-client/environments-and-variables/using-variables-in-api-requests)
[Using Variables in API Requests](/api-client/environments-and-variables/using-variables-in-api-requests)

Learn where and how to use variables in your API request URLs, headers, bodies, and scripts.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
Unlike environment, collection, or global variables which you define yourself, dynamic variables are available out of the box and always generate a fresh value when a request runs.

<Info>
Requestly uses [**Faker.js**](https://fakerjs.dev/) to generate realistic data for dynamic variables.

Check warning on line 14 in api-client/environments-and-variables/dynamic-variables.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestly) - vale-spellcheck

api-client/environments-and-variables/dynamic-variables.mdx#L14

Did you really mean 'Requestly'?
</Info>

They are accessed using the special `$` prefix syntax:
Expand Down Expand Up @@ -118,13 +118,13 @@

## Supported dynamic variables

Requestly provides a comprehensive set of built-in dynamic variables organized by category.

Check warning on line 121 in api-client/environments-and-variables/dynamic-variables.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestly) - vale-spellcheck

api-client/environments-and-variables/dynamic-variables.mdx#L121

Did you really mean 'Requestly'?

### Common

| Variable | Description | Example |
| ------------------- | --------------------------------- | -------------------------------------- |
| `{{$guid}}` | uuid-v4 style guid | `f47ac10b-58cc-4372-a567-0e02b2c3d479` |

Check warning on line 127 in api-client/environments-and-variables/dynamic-variables.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestly) - vale-spellcheck

api-client/environments-and-variables/dynamic-variables.mdx#L127

Did you really mean 'guid'?
| `{{$timestamp}}` | Current UNIX timestamp in seconds | `1739404800` |
| `{{$isoTimestamp}}` | Current ISO timestamp at zero UTC | `2026-02-13T14:25:30.177Z` |
| `{{$randomUUID}}` | A random 36-character UUID | `a3bb189e-8bf9-3888-9912-ace4e6543002` |
Expand Down Expand Up @@ -253,9 +253,9 @@

| Variable | Description | Example |
| ----------------------- | ------------------------ | -------------------------- |
| `{{$randomDateFuture}}` | A random future datetime | `2027-11-05T18:30:22.000Z` |

Check warning on line 256 in api-client/environments-and-variables/dynamic-variables.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestly) - vale-spellcheck

api-client/environments-and-variables/dynamic-variables.mdx#L256

Did you really mean 'datetime'?
| `{{$randomDatePast}}` | A random past datetime | `2023-08-14T15:45:33.000Z` |

Check warning on line 257 in api-client/environments-and-variables/dynamic-variables.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestly) - vale-spellcheck

api-client/environments-and-variables/dynamic-variables.mdx#L257

Did you really mean 'datetime'?
| `{{$randomDateRecent}}` | A random recent datetime | `2026-02-07T10:20:15.000Z` |

Check warning on line 258 in api-client/environments-and-variables/dynamic-variables.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestly) - vale-spellcheck

api-client/environments-and-variables/dynamic-variables.mdx#L258

Did you really mean 'datetime'?
| `{{$randomWeekday}}` | A random weekday | `Monday` |
| `{{$randomMonth}}` | A random month | `September` |

Expand Down Expand Up @@ -773,10 +773,10 @@
## What's Next?

<CardGroup cols={2}>
<Card icon="globe" href="/general/api-client/environments-and-variables/environment-variables" title="Environment Variables">
<Card icon="globe" href="/api-client/environments-and-variables/environment-variables" title="Environment Variables">
Store and manage auth tokens securely with variables
</Card>
<Card icon="bolt" href="/general/api-client/environments-and-variables/runtime-variables" title="Runtime Variables">
<Card icon="bolt" href="/api-client/environments-and-variables/runtime-variables" title="Runtime Variables">
Use temporary variables for request execution
</Card>
</CardGroup>
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
format: "MDX"
---

**Environment Variables** in Requestly allow you to configure API requests based on different environments—such as **Development**, **Staging**, or **Production**. They help you manage environment-specific values like base URLs, tokens, or credentials without manually editing each request when switching contexts.

Check warning on line 9 in api-client/environments-and-variables/environment-variables.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestly) - vale-spellcheck

api-client/environments-and-variables/environment-variables.mdx#L9

Did you really mean 'Requestly'?

<iframe className="w-full aspect-video rounded-xl" src="https://www.youtube.com/embed/0m00eSkuDcc" />

Expand All @@ -24,7 +24,7 @@

Example use cases:

* `{{base_url}}` points to [`https://dev.api.com`](https://dev.api.com) in development and [`https://api.com`](https://api.com) in production
* `{{base_url}}` points to `https://dev.api.com` in development and `https://api.com` in production

* Different `{{auth_token}}` for each environment

Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
format: "MDX"
---

Runtime variables in Requestly are **temporary variables** that last until the session is closed. Unlike environment or collection variables, they are available globally across all workspaces.

Check warning on line 9 in api-client/environments-and-variables/runtime-variables.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestly) - vale-spellcheck

api-client/environments-and-variables/runtime-variables.mdx#L9

Did you really mean 'Requestly'?

<Tip>
Runtime variables are the only type of variables that work **across multiple workspaces**.
Expand Down Expand Up @@ -62,7 +62,7 @@

You can use runtime variables just like environment or collection variables. Wrap the variable name in double curly braces `{{ }}`:

[`https://api.example.com/users/{{session_id}}`](https://api.example.com/users/\{\{session_id)
`https://api.example.com/users/{{session_id}}`

**Method 2: Set variables in scripts**\
You can define or update runtime variables in the **Scripts** tab using the `rq.variables` object.
Expand Down
File renamed without changes.
File renamed without changes.
8 changes: 4 additions & 4 deletions general/api-client/examples.mdx → api-client/examples.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
title: "Create Request & Response Examples"
label: "Request Examples"
slug: "examples"
description: "Save, manage, and reuse examples in Requestly. Create snapshots of your API requests with different configurations for quick reuse."

Check warning on line 5 in api-client/examples.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestly) - vale-spellcheck

api-client/examples.mdx#L5

Did you really mean 'Requestly'?
seoTitle: "Request Examples"
seoDescription: "Save, manage, and reuse request examples in Requestly. Create snapshots of your API requests with different configurations for quick reuse."

Check warning on line 7 in api-client/examples.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestly) - vale-spellcheck

api-client/examples.mdx#L7

Did you really mean 'Requestly'?
visibility: "PUBLIC"
---

Expand Down Expand Up @@ -103,15 +103,15 @@
## What's next?

<CardGroup cols={3}>
<Card title="API Collections" icon="folder" href="/general/api-client/api-collections">
<Card title="API Collections" icon="folder" href="/api-client/api-collections">
Organize your requests into collections and folders
</Card>

<Card title="Variables" icon="brackets-curly" href="/general/api-client/environments-and-variables">
<Card title="Variables" icon="brackets-curly" href="/api-client/environments-and-variables">
Use variables to make requests reusable across environments
</Card>

<Card title="Scripts & Tests" icon="code" href="/general/api-client/scripts">
<Card title="Scripts & Tests" icon="code" href="/api-client/scripts">
Add pre-request scripts and tests to automate your workflow
</Card>
</CardGroup>
</CardGroup>
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title: Import / Export
label: Import / Export
title: Overview
label: Overview
slug: import-export
description: |-
Learn how to import and export API collections, environments, and requests
in Requestly.

Check warning on line 7 in api-client/import-export.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestly) - vale-spellcheck

api-client/import-export.mdx#L7

Did you really mean 'Requestly'?
visibility: PUBLIC
---
Requestly’s API Client makes it easy to move your work across devices, collaborate with teammates, and back up your collections and environments using powerful import/export features.
Requestly makes it easy to move your work across devices, collaborate with teammates, and back up your collections and environments using powerful import/export features.

Check warning on line 10 in api-client/import-export.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestly) - vale-spellcheck

api-client/import-export.mdx#L10

Did you really mean 'Requestly'?

This section covers everything you need to know about:

Expand All @@ -20,22 +20,22 @@

## Supported Imports

* [Import from cURL](/general/api-client/import-export/import-from-curl)
* [Import from cURL](/api-client/import-export/import-from-curl)

Paste a raw `curl` command and convert it into a fully configured request.

* [Import/Export Collections](/general/api-client/import-export/import-export-api-collections)
* [Import/Export Collections](/api-client/import-export/import-export-api-collections)

Upload or download `.json` files to share, back up, or migrate your API collections.

* [Import/Export Environments](/general/api-client/import-export/import-export-api-environment)
* [Import/Export Environments](/api-client/import-export/import-export-api-environment)

Bring in or export environment variables like tokens, base URLs, and custom keys — all using simple `.json` files.

* [Import from Postman](/general/api-client/import-export/import-from-postman)
* [Import from Postman](/api-client/import-export/import-from-postman)

Upload a Postman collection `.json` file to use it inside Requestly.

Check warning on line 37 in api-client/import-export.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestly) - vale-spellcheck

api-client/import-export.mdx#L37

Did you really mean 'Requestly'?

* [Import from Bruno](/general/imports/bruno)
* [Import from Bruno](/http-interception/imports/bruno)

Migrate your API collection from Bruno by importing its `.json` export.
Loading