Skip to main content

​
API and Product Coverage

This document provides a comprehensive overview of what the kagi CLI currently implements, what is planned, and what is intentionally deferred.

​
Currently Implemented

​
Documented Kagi APIs

These are official, documented API endpoints:
EndpointCommandStatus
Search APIkagi search✅ Implemented (with fallback)
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 (Session Token):
FeatureCommandStatus
Base Searchkagi search✅ Implemented (session path)
Lens Searchkagi search --lens✅ Implemented
Web Summarizerkagi summarize --subscriber✅ Implemented
Assistantkagi assistant✅ 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

​
Implementation Status Summary

​
Commands

CommandDescriptionAuthStatus
searchKagi searchAPI/Session✅
search --lensLens searchSession✅
authCredential managementNone✅
summarizePublic API summarizerAPI✅
summarize --subscriberWeb summarizerSession✅
newsNews feedNone✅
assistantAI assistantSession✅
fastgptFast answersAPI✅
enrich webWeb enrichmentAPI✅
enrich newsNews enrichmentAPI✅
smallwebSmall web feedNone✅

​
Command Options

OptionCommandsStatus
--prettysearch✅
--lenssearch✅
--limitnews, smallweb✅
--categorynews✅
--list-categoriesnews✅
--chaosnews✅
--urlsummarize✅
--textsummarize✅
--subscribersummarize✅
--lengthsummarize (subscriber)✅
--summary-typesummarize (subscriber)✅
--enginesummarize (API)✅
--cachesummarize (API), fastgpt✅
--web-searchfastgpt✅
--target-languagesummarize✅
--thread-idassistant✅

​
Deferred Features

​
Intentionally Excluded

These features were evaluated but excluded:

​
Translate

Status: ❌ Deferred Reason: The current Session Link implementation is not sufficient for translate.kagi.com as deployed. The endpoint requires additional authentication mechanisms that are incompatible with the Session Link token model. Decision: Rather than ship a fragile compatibility layer that might break, the feature was excluded pending a viable authentication path. Alternative: Use the web interface at translate.kagi.com

​
Future Considerations

These may be implemented in future versions:
  • Additional summarization engines
  • More Assistant features (beyond prompt/thread)
  • Additional news categories
  • Enhanced lens management
  • Batch operations
  • Export formats

​
API Surface Philosophy

​
What Gets Implemented

  1. Documented APIs - Official Kagi API endpoints
  2. Stable Product Seams - Web product features with stable interfaces
  3. Public Endpoints - No-auth features available to all
  4. High-Value Features - Most requested capabilities

​
What Gets Deferred

  1. Fragile Interfaces - Features requiring brittle reverse engineering
  2. Breaking Changes - APIs known to be unstable
  3. Low Demand - Rarely requested features
  4. Maintenance Burden - High-complexity, low-value features

​
Authentication Coverage

​
Supported Credential Types

TypeSupportCommands
Session Token✅search, summarize —subscriber, assistant
API Token✅search, summarize, fastgpt, enrich

​
Authentication Patterns

PatternImplementation
Single token✅ Supported
Dual token✅ Supported
Environment variables✅ Supported
Config file✅ Supported
Token fallback✅ search only

​
Output Format Coverage

​
JSON Output

All commands output JSON:
CommandSchema Stability
searchStable
newsStable
smallwebStable
summarizeStable
assistantStable
fastgptStable
enrichStable

​
Pretty Output

CommandPretty Mode
search✅ Yes
news❌ No (use jq)
smallweb❌ No (use jq)
Others❌ JSON only

​
Platform Coverage

​
Operating Systems

PlatformSupport
macOS (Intel)✅
macOS (Apple Silicon)✅
Linux (x86_64)✅
Linux (ARM64)✅
Windows (x64)✅
Windows (ARM64)✅

​
Installation Methods

MethodSupport
Install script✅
Homebrew✅
Scoop✅
npm✅
Cargo✅
GitHub Releases✅
Build from source✅

​
Feature Comparison Matrix

​
vs Kagi Web Product

FeatureCLIWeb
Search✅✅
Lens Search✅✅
Assistant✅ (basic)✅ (full)
Summarizer✅✅
Translate❌✅
Settings❌✅
Billing❌✅

​
vs Kagi API

EndpointCLIDirect API
Search✅✅
Summarizer✅✅
FastGPT✅✅
Enrichment✅✅
Requires auth handlingCLI managesManual
JSON parsingCLI doesManual
Error handlingCLI managesManual

​
Version Compatibility

​
API Versions

The CLI targets these API versions:
APIVersionNotes
Search APIv1Current stable
Universal Summarizerv1Current stable
FastGPTv1Current stable
Enrichmentv1Current stable

​
Breaking Changes

When Kagi APIs change:
  1. CLI is updated to match
  2. Version compatibility notes added
  3. Migration guides provided if needed

​
Contributing New Features

​
Process

  1. Proposal - Open issue describing feature
  2. Feasibility - Check API/product availability
  3. Design - Agree on interface
  4. Implementation - Code + tests
  5. Documentation - Update docs
  6. Release - Include in next version

​
Guidelines

  • Prefer documented APIs over scraping
  • Maintain backward compatibility
  • Follow existing command patterns
  • Include comprehensive tests
  • Document auth requirements

​
Roadmap

​
Near Term (Next 3 Months)

  • Bug fixes and stability improvements
  • Documentation enhancements
  • Platform-specific optimizations

​
Medium Term (3-6 Months)

  • Additional output formats
  • Enhanced error messages
  • Performance improvements

​
Long Term (6+ Months)

  • New Kagi API features as available
  • Community-requested enhancements
  • Integration improvements

​
Reporting Coverage Issues

If you find:
  • Missing documented features
  • Broken functionality
  • Documentation errors
Please open an issue: Include:
  • Expected behavior
  • Actual behavior
  • kagi version
  • OS/platform