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

# SurfSense

> How to use Linkup with SurfSense

## Overview

Linkup can be used with [SurfSense](https://github.com/MODSetter/SurfSense) as a Search Engine connector to create advanced AI agents and workflows based on internal and web data.

## Getting Started with Linkup in SurfSense

<Steps>
  <Step title="Setup SurfSense">
    Follow the guides here.

    1. [Setting up Docker](https://github.com/MODSetter/SurfSense/blob/main/surfsense_web/content/docs/docker-installation.mdx)
    2. [Setting up environment variables](https://github.com/MODSetter/SurfSense/blob/main/surfsense_web/content/docs/index.mdx)
  </Step>

  <Step title="Get your Linkup API Key">
    <Card title="Get your API key" icon="key" href="https://app.linkup.so" horizontal="True">
      Create a Linkup account for free to get your API key.
    </Card>
  </Step>

  <Step title="Add Linkup Connector">
    Navigate to the Add Connector page under Connectors section in SurfSense and configure with your Linkup API Key.

    <img src="https://mintcdn.com/linkup-8b5c238e/ht3XJF6azWwbELaV/pages/integrations/surfsense/assets/connector_page.png?fit=max&auto=format&n=ht3XJF6azWwbELaV&q=85&s=ce602cf7ec1742b87ea5a3a218a2d9a6" alt="Connector Page" width="1294" height="603" data-path="pages/integrations/surfsense/assets/connector_page.png" />

    <img src="https://mintcdn.com/linkup-8b5c238e/ht3XJF6azWwbELaV/pages/integrations/surfsense/assets/config_connector.png?fit=max&auto=format&n=ht3XJF6azWwbELaV&q=85&s=576e0b3718b305bb3f6bf64f4f331bd4" alt="Adding Linkup API" width="1444" height="1268" data-path="pages/integrations/surfsense/assets/config_connector.png" />
  </Step>

  <Step title="Select the Linkup Connector during Research">
    While performing a query under Researcher, select the Linkup Connector and save it.

    <img src="https://mintcdn.com/linkup-8b5c238e/oh3ymISFMHZ8Z97k/pages/integrations/surfsense/assets/selecting_linkup.png?fit=max&auto=format&n=oh3ymISFMHZ8Z97k&q=85&s=6a8d2c45d74b75e0cb53c2c608555ab0" alt="Selecting Linkup Connector" width="1303" height="621" data-path="pages/integrations/surfsense/assets/selecting_linkup.png" />
  </Step>

  You are all set to use the Linkup [**Search**](/pages/documentation/endpoints/search/overview) API with SurfSense.
</Steps>

## Example

<img src="https://mintcdn.com/linkup-8b5c238e/oh3ymISFMHZ8Z97k/pages/integrations/surfsense/assets/example_usage.png?fit=max&auto=format&n=oh3ymISFMHZ8Z97k&q=85&s=f42e1bfe76283e2973b90c795a90034c" alt="Example Usage - Linkup with Surfsense" width="898" height="1506" data-path="pages/integrations/surfsense/assets/example_usage.png" />

<Info>
  **Need help?** Email `support@linkup.so`, ping us on [Discord](https://discord.com/invite/9q9mCYJa86), or [talk to us](https://calendar.app.google/zNUZz7RxgMMk9pKW7).
</Info>