summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/dev/engines/online/brave.rst25
1 files changed, 22 insertions, 3 deletions
diff --git a/docs/dev/engines/online/brave.rst b/docs/dev/engines/online/brave.rst
index a1c589b9d..96606f3bf 100644
--- a/docs/dev/engines/online/brave.rst
+++ b/docs/dev/engines/online/brave.rst
@@ -1,5 +1,3 @@
-.. _brave engine:
-
=============
Brave Engines
=============
@@ -9,5 +7,26 @@ Brave Engines
:local:
:backlinks: entry
+Brave offers two different engines for SearXNG:
+
+1. The standard engine (``brave``) uses the web interface.
+2. The API engine (``braveapi``) uses the official REST API.
+
+.. _brave engine:
+
+Brave Standard Engine
+---------------------
+
.. automodule:: searx.engines.brave
- :members:
+ :members:
+
+.. _braveapi engine:
+
+Brave API Engine
+----------------
+
+.. automodule:: searx.engines.braveapi
+ :members:
+
+The API engine requires an API key from Brave. This can be obtained from the
+`API Dashboard <https://api-dashboard.search.brave.com/>`_.