> For the complete documentation index, see [llms.txt](https://whitepaper.aitech.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://whitepaper.aitech.io/agentforge/tools/linkup.md).

# linkup

[Linkup](https://linkup.so/) is a powerful web search tool that integrates seamlessly with Agent Forge, allowing your AI agents to access up-to-date information from the web with proper source attribution.

Linkup enhances your AI agents by providing them with the ability to search the web for current information. When integrated into your agent's toolkit:

* **Real-time Information Access**: Agents can retrieve the latest information from the web, keeping responses current and relevant.
* **Source Attribution**: All information comes with proper citations, ensuring transparency and credibility.
* **Simple Implementation**: Add Linkup to your agents toolset with minimal configuration.
* **Contextual Awareness**: Agents can use web information while maintaining their personality and conversational style.

To implement Linkup in your agent, simply add the tool to your agent's configuration. Your agent will then be able to search the web whenever they need to answer questions requiring current information.

### Usage Instructions

Linkup Search allows you to search and retrieve up-to-date information from the web with source attribution.

### Tools

#### `linkup_search`

Search the web for information using Linkup

**Input**

| Parameter    | Type   | Required | Description                                |
| ------------ | ------ | -------- | ------------------------------------------ |
| `q`          | string | Yes      | The search query                           |
| `depth`      | string | Yes      | Search depth (has to either be             |
| `outputType` | string | Yes      | Type of output to return (has to either be |
| `apiKey`     | string | Yes      | Enter your Linkup API key                  |

**Output**

| Parameter | Type   | Description       |
| --------- | ------ | ----------------- |
| `answer`  | string | Generated answer  |
| `sources` | json   | Source references |

### Notes

* Category: `tools`
* Type: `linkup`


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://whitepaper.aitech.io/agentforge/tools/linkup.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.