Skip to content
Back to top
View this page
Edit this page

# Kagi Engines

Kagi is a paid, privacy-focused search engine.

Using it requires an API key. If you have a Kagi account, you can obtain an API key in the API portal.

To enable Kagi, add the following to the `engines` seciton of `settings.yml`:

    - name: kagi
      engine: kagi
      categories: [general, web]
      shortcut: kg
      api_key: ""
      kagi_categ: search

    - name: kagi.news
      engine: kagi
      categories: [news, web]
      shortcut: kgn
      api_key: ""
      kagi_categ: news

    - name: kagi.images
      engine: kagi
      categories: [images, web]
      shortcut: kgi
      paging: false
      api_key: ""
      kagi_categ: images

    - name: kagi.videos
      engine: kagi
      categories: [videos, web]
      shortcut: kgv
      api_key: ""
      kagi_categ: videos

searx.engines.kagi.paging = True

  All categories except the `images` category support paging.

searx.engines.kagi.kagi_categ: Literal ['search', 'images', 'news', 'videos'] = 'search'

  Search category. Supported values: “search” (general), “images”, “news”, “videos”.

searx.engines.kagi.api_key = ''

  Kagi API key. Required for using this engine.