​
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

To use the Brave Search integration, you need an API key. You can obtain this key by signing up at Brave.

​
How to Use the Integration

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

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.
2

Create Task Definition

Use the following YAML configuration to define your search task:
Brave Search Example
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

​
YAML Explanation

  • 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.
  • 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.
  • 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.
Remember to replace BRAVE_API_KEY with your actual API key. Customize the query parameter to suit your specific search needs.

​
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.
For more information, please refer to the Brave Search API documentation.