> ## Documentation Index
> Fetch the complete documentation index at: https://docs.requestly.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Getting Started

> Install the Requestly API Client, send your first request, save it to a collection, and set up environment variables.

Requestly API Client is a lightweight, privacy-first tool for sending API requests, organizing them into collections, and automating tests with scripts. All your data stays local on your machine.

***

## Step 1: Install

The API Client runs as a **desktop app** on macOS, Windows, and Linux.

<Tabs>
  <Tab title="macOS">
    Download the latest version for [Apple Silicon](https://get.requestly.com/mac-api-client) or [Intel](https://get.requestly.com/mac-intel-api-client).
  </Tab>

  <Tab title="Windows">
    Download the [Windows installer](https://get.requestly.com/win-api-client).
  </Tab>

  <Tab title="Linux">
    Download the [Linux AppImage](https://get.requestly.com/linux-api-client).
  </Tab>
</Tabs>

<Info>
  **What about the browser extension?** The Requestly browser extension is a separate product, an HTTP interceptor for modifying network traffic. The API Client is a standalone desktop app. You do not need the extension to use the API Client.
</Info>

***

## Step 2: Create an Account (Optional)

You can start using the API Client immediately, **no account required**. All requests, collections, and environments are stored locally.

If you want to sync data across devices or collaborate with a team, sign in with your Google or email account from the top-right menu.

***

## Step 3: Send Your First Request

<Steps>
  <Step title="Create a New Request">
    Click **+ New** → **Request** in the left sidebar.

    <img src="https://mintcdn.com/requestly/ogpkiZr9UzVkhnxb/images/API-client---9.png?fit=max&auto=format&n=ogpkiZr9UzVkhnxb&q=85&s=e2ef8628c00ac744b84d1cc332c83d22" align="center" fullwidth="false" className="dark:hidden" width="2400" height="1400" data-path="images/API-client---9.png" />

    <img src="https://mintcdn.com/requestly/ogpkiZr9UzVkhnxb/images/API-client---9-2.png?fit=max&auto=format&n=ogpkiZr9UzVkhnxb&q=85&s=07c85a6727e77c45052767fe49f5f771" align="center" fullwidth="false" className="hidden dark:block" width="2400" height="1400" data-path="images/API-client---9-2.png" />
  </Step>

  <Step title="Enter the URL">
    Set the method to **GET** and enter:

    ```text theme={null}
    https://app.requestly.io/echo
    ```

    <img src="https://mintcdn.com/requestly/ogpkiZr9UzVkhnxb/images/API-client---2.png?fit=max&auto=format&n=ogpkiZr9UzVkhnxb&q=85&s=9feb4a49fb72fd36644161ad26d87052" align="center" fullwidth="false" className="dark:hidden" width="2400" height="1146" data-path="images/API-client---2.png" />

    <img src="https://mintcdn.com/requestly/ogpkiZr9UzVkhnxb/images/API-client---2-1.png?fit=max&auto=format&n=ogpkiZr9UzVkhnxb&q=85&s=7ef3b7c0258c25bdcbc1a48f01fe5e2f" align="center" fullwidth="false" className="hidden dark:block" width="2400" height="1146" data-path="images/API-client---2-1.png" />
  </Step>

  <Step title="Hit Send">
    Click **Send**. You’ll see the echo server’s JSON response in the panel below.

    <img src="https://mintcdn.com/requestly/ogpkiZr9UzVkhnxb/images/API-client---12.png?fit=max&auto=format&n=ogpkiZr9UzVkhnxb&q=85&s=245871d75135127d824fc131ab5d66cd" align="center" fullwidth="false" className="dark:hidden" width="2400" height="1400" data-path="images/API-client---12.png" />

    <img src="https://mintcdn.com/requestly/ogpkiZr9UzVkhnxb/images/API-client---12-2.png?fit=max&auto=format&n=ogpkiZr9UzVkhnxb&q=85&s=5e05ae58659f49ef0f51f3ab0ad72cdf" align="center" fullwidth="false" className="hidden dark:block" width="2400" height="1400" data-path="images/API-client---12-2.png" />
  </Step>
</Steps>

You’ve sent your first request. The response panel shows the body, headers, status code, and response time.

***

## Step 4: Save to a Collection

Collections keep related requests organized together.

<Steps>
  <Step title="Create a Collection">
    Click **+ New** → **Collection**. Name it `My APIs`.

    <img src="https://mintcdn.com/requestly/ogpkiZr9UzVkhnxb/images/API-Collection---1-1.png?fit=max&auto=format&n=ogpkiZr9UzVkhnxb&q=85&s=26f27fe7484982a24f5f1617fac3e1fc" align="center" fullwidth="false" className="dark:hidden" width="2400" height="1400" data-path="images/API-Collection---1-1.png" />

    <img src="https://mintcdn.com/requestly/ogpkiZr9UzVkhnxb/images/API-Collection---1-2.png?fit=max&auto=format&n=ogpkiZr9UzVkhnxb&q=85&s=41d81cc88f8026efa7e0e07363b4ea00" align="center" fullwidth="false" className="hidden dark:block" width="2400" height="1400" data-path="images/API-Collection---1-2.png" />
  </Step>

  <Step title="Move Your Request Into It">
    Drag the request you just created into the collection, or click the **+** icon next to the collection name to create new requests directly inside it.
  </Step>
</Steps>

You can also create folders inside collections to group requests by feature or endpoint. [Learn more about collections →](/api-client/api-collections)

***

## Step 5: Add an Environment Variable

Environment variables let you switch between dev, staging, and production without editing every request.

<Steps>
  <Step title="Create an Environment">
    Click **+ New** → **Environment**. Name it `Development`.

    <img src="https://mintcdn.com/requestly/ogpkiZr9UzVkhnxb/images/API-client---9-5.png?fit=max&auto=format&n=ogpkiZr9UzVkhnxb&q=85&s=e3aeee6500d9b8e54ef80ed5bc28e0bb" align="center" fullwidth="false" className="dark:hidden" width="2400" height="1400" data-path="images/API-client---9-5.png" />

    <img src="https://mintcdn.com/requestly/ogpkiZr9UzVkhnxb/images/API-client---9-3.png?fit=max&auto=format&n=ogpkiZr9UzVkhnxb&q=85&s=8137d932751b50e86ccf89a457f89477" align="center" fullwidth="false" className="hidden dark:block" width="2400" height="1400" data-path="images/API-client---9-3.png" />
  </Step>

  <Step title="Add a Variable">
    Add a variable:

    * **Key**: `base_url`
    * **Value**: `https://app.requestly.io`

    Click **Save**.

    <img src="https://mintcdn.com/requestly/ogpkiZr9UzVkhnxb/images/API-client---13-1.png?fit=max&auto=format&n=ogpkiZr9UzVkhnxb&q=85&s=687a2aeb5fb7fc5c706befaa84dc511c" align="center" fullwidth="false" className="dark:hidden" width="2400" height="1316" data-path="images/API-client---13-1.png" />

    <img src="https://mintcdn.com/requestly/ogpkiZr9UzVkhnxb/images/API-client---13.png?fit=max&auto=format&n=ogpkiZr9UzVkhnxb&q=85&s=5eb16e1f962ddb9930d159c9a4790a73" align="center" fullwidth="false" className="hidden dark:block" width="2400" height="1316" data-path="images/API-client---13.png" />
  </Step>

  <Step title="Use It in a Request">
    Replace the URL in your request with:

    ```text theme={null}
    {{base_url}}/echo
    ```

    Variables use double curly braces: `{{variable_name}}`

    <img src="https://mintcdn.com/requestly/ogpkiZr9UzVkhnxb/images/API-client---11.png?fit=max&auto=format&n=ogpkiZr9UzVkhnxb&q=85&s=1cb0b403e7296db888d0f88c24bc1bbc" align="center" fullwidth="false" className="dark:hidden" width="2400" height="1316" data-path="images/API-client---11.png" />

    <img src="https://mintcdn.com/requestly/ogpkiZr9UzVkhnxb/images/API-client---11-1.png?fit=max&auto=format&n=ogpkiZr9UzVkhnxb&q=85&s=12ed03076973d5529bc5d9a0fbf77d9f" align="center" fullwidth="false" className="hidden dark:block" width="2400" height="1316" data-path="images/API-client---11-1.png" />
  </Step>
</Steps>

Now you can create a `Production` environment with a different `base_url` and switch between them using the environment dropdown. [Learn more about variables →](/api-client/environments-and-variables)

***

## What’s Next

<CardGroup cols={2}>
  <Card title="Authorization" icon="shield" href="/api-client/send-api-request/authorization">
    Add API Key, Bearer Token, or Basic Auth to your requests.
  </Card>

  <Card title="Scripts" icon="wand-magic-sparkles" href="/api-client/scripts">
    Run JavaScript before requests or after responses for automation.
  </Card>

  <Card title="Tests" icon="flask" href="/api-client/tests">
    Write assertions to validate API responses automatically.
  </Card>

  <Card title="Collection Runner" icon="play" href="/api-client/collection-runner">
    Execute an entire collection of requests in sequence.
  </Card>

  <Card title="Import from Postman" icon="box" href="/api-client/import-export/import-from-postman">
    Bring your existing Postman collections into Requestly.
  </Card>

  <Card title="Import from cURL" icon="terminal" href="/api-client/import-export/import-from-curl">
    Paste a cURL command and convert it to a request instantly.
  </Card>
</CardGroup>
