Skip to main content

Documentation Index

Fetch the complete documentation index at: https://kagi.micr.dev/llms.txt

Use this file to discover all available pages before exploring further.

​
API and Product Coverage

This document summarizes what the kagi CLI implements today, which auth path it uses, and which product settings are now manageable from the terminal.

​
Currently Implemented

​
Documented Kagi APIs

These are official, documented API endpoints:
EndpointCommandStatus
Search APIkagi search✅ Implemented for base search
Universal Summarizerkagi summarize✅ Implemented
FastGPTkagi fastgpt✅ Implemented
Web Enrichment (Teclis)kagi enrich web✅ Implemented
News Enrichment (TinyGem)kagi enrich news✅ Implemented

​
Subscriber Web Product Features

These features use the subscriber web product with KAGI_SESSION_TOKEN:
FeatureCommandStatus
Base searchkagi search✅ Implemented
Snap-prefixed searchkagi search --snap✅ Implemented
Lens searchkagi search --lens✅ Implemented
Filtered searchkagi search --region/--time/...✅ Implemented
Quick Answerkagi quick✅ Implemented
Web Summarizerkagi summarize --subscriber✅ Implemented
Assistant prompt + thread managementkagi assistant✅ Implemented
Custom assistant managementkagi assistant custom✅ Implemented
Ask questions about a pagekagi ask-page✅ Implemented
Translate (text mode)kagi translate✅ Implemented
Lens settingskagi lens✅ Implemented
Custom bang settingskagi bang custom✅ Implemented
Redirect rule settingskagi redirect✅ Implemented

​
Public Product Endpoints

These require no authentication:
EndpointCommandStatus
Kagi Newskagi news✅ Implemented
Small Web feedkagi smallweb✅ Implemented
News categorieskagi news --list-categories✅ Implemented
Chaos indexkagi news --chaos✅ Implemented

​
Command Coverage Summary

CommandDescriptionAuthStatus
searchBase Kagi searchAPI or Session✅
search --snapSnap-prefixed searchAPI or Session✅
search --lensLens-aware searchSession✅
search with filtersRegion, time, date, order, verbatim, personalization filtersSession✅
batchParallel search with shared search optionsAPI or Session✅
authCredential managementNone✅
summarizePublic API summarizerAPI✅
summarize --subscriberWeb summarizerSession✅
newsNews feed and metadataNone✅
quickQuick AnswerSession✅
assistantAI assistant prompt + thread managementSession✅
assistant customSaved assistant CRUDSession✅
ask-pagePage-focused Assistant questionSession✅
translateKagi Translate text modeSession✅
fastgptFast answersAPI✅
enrich webWeb enrichmentAPI✅
enrich newsNews enrichmentAPI✅
smallwebSmall Web feedNone✅
lensLens CRUD + enable/disableSession✅
bang customCustom bang CRUDSession✅
redirectRedirect CRUD + enable/disableSession✅

​
Output and Flag Coverage

​
Human-Readable Formats

CommandFormats
searchjson, compact, pretty, markdown, csv
batchjson, compact, pretty, markdown, csv
quickjson, compact, pretty, markdown
assistantjson, compact, pretty, markdown

​
Search Options

OptionCommandsStatus
--snapsearch, batch✅
--lenssearch, batch, quick✅
--regionsearch, batch✅
--timesearch, batch✅
--from-datesearch, batch✅
--to-datesearch, batch✅
--ordersearch, batch✅
--verbatimsearch, batch✅
--personalized / --no-personalizedsearch, batch, assistant✅

​
Assistant and Settings Options

OptionCommandsStatus
--assistantassistant✅
--thread-idassistant✅
--modelassistant, assistant custom✅
--lensassistant, assistant custom✅
--web-access / --no-web-accessassistant, assistant custom✅
thread list/get/delete/exportassistant✅
custom list/get/create/update/deleteassistant✅
list/get/create/update/deletelens✅
enable / disablelens, redirect✅
custom list/get/create/update/deletebang✅

​
Live Verification

Live subscriber CRUD and round-trip tests were run against the real product flows for:
  • custom assistants
  • lenses
  • custom bangs
  • redirect rules
  • assistant thread round-trip
After those tests, the account-level settings pages were checked directly to confirm cleanup and no leftover test data.

​
Not Available

​
Intentionally Excluded

  • File-upload Assistant workflows are not exposed.
  • Kagi Translate document, image, website, proofread, dictionary, and voice modes are not exposed.
  • Search-time safe-search overrides are not exposed. Safe-search remains an account setting.

​
Notes

  • Base-search fallback to the session-token path only exists on kagi search and kagi batch, and only when API-first mode was selected.
  • Search filters and lens search remain session-only because they depend on Kagi’s live web-product flow.
  • Settings management currently targets Kagi’s authenticated settings forms, not public API endpoints.