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

# Brave

> Learn how to use the Brave integration with Julep

## Overview

Welcome to the Brave Search integration guide for Julep! This integration allows you to perform web searches using Brave, enabling you to build workflows that require comprehensive search capabilities. Whether you're developing a search engine or need to retrieve web data, this guide will walk you through the setup and usage.

## Prerequisites

<Info type="info" title="API Key Required">
  To use the Brave Search integration, you need an API key. You can obtain this key by signing up at [Brave](https://brave.com/search/api/).
</Info>

## How to Use the Integration

To get started with the Brave Search integration, follow these steps to configure and create a task:

<Steps>
  <Step title="Configure Your API Key">
    Add your API key to the tools section of your task. This will allow Julep to authenticate requests to Brave Search on your behalf.
  </Step>

  <Step title="Create Task Definition">
    Use the following YAML configuration to define your search task:

    ```yaml Brave Search Example theme={"dark"}
    name: Brave Search Task
    tools:
    - name: brave_search
      type: integration
      integration:
        provider: brave
        method: search
        setup:
          brave_api_key: "BRAVE_API_KEY"

    main:
    - tool: brave_search
      arguments:
        query: latest technology trends
    ```
  </Step>
</Steps>

### YAML Explanation

<AccordionGroup>
  <Accordion title="Basic Configuration">
    * ***name***: A descriptive name for the task, in this case, "Brave Search Task".
    * ***tools***: This section lists the tools or integrations being used. Here, `brave_search` is defined as an integration tool.
  </Accordion>

  <Accordion title="Tool Configuration">
    * ***type***: Specifies the type of tool, which is `integration` in this context.
    * ***integration***: Details the provider and setup for the integration.
      * ***provider***: Indicates the service provider, which is `brave` for Brave Search.
      * ***method***: Indicates the method to be used, which is `search` for Brave Search. If not specified, the method will be `search` by default.
      * ***setup***: Contains configuration details, such as the API key (`api_key`) required for authentication.
  </Accordion>

  <Accordion title="Workflow Configuration">
    * ***main***: Defines the main execution steps.
      * ***tool***: Refers to the tool defined earlier (`brave_search`).
      * ***arguments***: Specifies the input parameters for the tool:
        * ***query***: The search query for Brave Search.
  </Accordion>
</AccordionGroup>

<Note>
  Remember to replace `BRAVE_API_KEY` with your actual API key. Customize the `query` parameter to suit your specific search needs.
</Note>

## Conclusion

With the Brave Search integration, you can efficiently perform web searches and retrieve relevant data.
This integration provides a robust solution for search capabilities, enhancing your workflow's functionality and user experience.

<Tip>
  For more information, please refer to the [Brave Search API documentation](https://api.search.brave.com/app/documentation/web-search/get-started).
</Tip>