kagi_ex

kagi_ex is a typed Elixir client for Kagi Search, Summarizer, and Maps.

It builds Req requests and sends them through cloaked_req.

Installation

def deps do
  [
    {:kagi_ex, "~> 0.2.0"}
  ]
end

Authentication

Kagi requires a session token. Log in at kagi.com, open your browser's cookies for the site, and copy the value of the kagi_session cookie - only the value, not the whole Cookie header. Put it in application config:

config :kagi_ex,
  session_token: System.fetch_env!("KAGI_SESSION_TOKEN")

Tokens with characters that cannot appear in a cookie value (a pasted key=value; other=... header, for example) return {:error, %Kagi.Error{reason: :invalid_session_token}}.

Usage

{:ok, results} =
  Kagi.search("elixir req http client",
    lens: :programming,
    limit: 5
  )

Enum.map(results.results, & &1.url)

Configuration

Set :req_options in application config when you need to override the default Req request options, including CloakedReq adapter options such as :impersonate.

Requests follow no redirects and retry nothing by default, so one call maps to one HTTP request and the session cookie never travels to another host. Opt back in via :req_options with redirect: true or retry: :safe_transient.

Search Options

Kagi.search/2 and Kagi.search/3 accept:

:limit - maximum result count
:region - region code such as "ch", "us", "de", or "no_region"
:lens - :default, :programming, :forums, :pdfs, :non_commercial, or :world_news
:sort - :recency, :website, or :ad_trackers
:time - :day, :week, :month, or :year
:from / :to - YYYY-MM-DD date range; cannot be combined with :time
:site - appends a site: filter
:filetype - appends a filetype: filter
:verbatim - disables query expansion when true

Summarizer Options

Kagi.summarize/2 and Kagi.summarize/3 accept:

:type - :summary or :takeaway
:lang - target language code, default "EN"
:timeout - total request timeout in milliseconds; defaults to req_options[:receive_timeout] when set, otherwise 60 seconds

Maps

{:ok, output} =
  Kagi.maps("coffee zurich",
    ll: "47.3769,8.5417",
    zoom: 13,
    sort: :rating
  )

Enum.map(output.results, & &1.name)

Kagi.maps/2 and Kagi.maps/3 accept:

:limit - maximum result count (default 10)
:ll - center coordinate as "LAT,LON"
:bbox - bounding box as "WEST,SOUTH,EAST,NORTH"
:zoom - zoom level (number)
:sort - :relevance, :rating, :distance, or :price
:order - :asc or :desc; defaults are :desc for :rating, :asc for :distance and :price

Sorting and the limit apply client-side to the parsed response.

Returned Types

Search returns {:ok, %Kagi.Search{results: [...], related: [...]}}, where each result is a %Kagi.SearchResult{url: ..., title: ..., snippet: ...}.

Summarizer returns {:ok, %Kagi.Summary{summary: markdown}}.

Maps returns {:ok, %Kagi.Maps{results: [%Kagi.MapsResult{}]}}. Each Kagi.MapsResult carries name, address, coordinates (%Kagi.MapsResult.Coordinates{latitude:, longitude:}), plus optional phone, url, source, id, rating, review_count, price, distance, hours_now, types, links, and images.

Failures return {:error, %Kagi.Error{reason: reason, message: message}}.

Development Checks

Run deterministic local checks:

task check

Run opt-in live Kagi checks with a real session token:

export KAGI_SESSION_TOKEN="..."
task test:live

Next Page → Changelog