Rust API client for openapi

The Kagi API provides programmatic access to data that powers our search results & more.

Quick start for all APIs:

• Create an account at Kagi
• Generate an API key
• Call the API

We have the following APIs available.

Commercial

• Kagi Search API (invite only at the moment)
• Web and News Enrichment API (public, exposes Kagi's own indexes Teclis and TinyGem)
• Universal Summarizer API (public)
• FastGPT API (public)

Free

• Kagi Small Web RSS feed (public)

Official Client Libraries

We offer the following libraries you can use to interact with the Kagi API. These are generated from an OpenAPI spec. If you have a language you would like to use and it's not in the list, send us a message and we will add it to the list if it is supported. Or you can use the spec to build your own custom library.

• Golang
• Python
• Rust

Unofficial Client Libraries

There also exist third party libraries for interacting with the Kagi API.

• kagigo for Go - FastGPT & Universal Summarizer
• kagi-api for Rust
• kagi-api for Ruby
• kagi-dotnet for C#/.NET

API Status

Our existing API, the "v0" beta API, is being replaced with a new version that will be available publicly soon. As changes are made, we will be updating the documentation below when the new features become available.

See the Support and Community section for details.

Pricing

We are in the process of moving all APIs to a post-paid tiered system, where each tier has a limit on the number of requests that can be made. If an API has a pricing section, then it is still being migrated over to the new billing system.

GitHub Discussions

This is the preferred venue for bug reports and feature requests.

• Bug Reports
• Q&A Forum
• API Feature Requests

Discord

Join our Discord! Good for quick questions or chatting about things you've made with our APIs!

For more information, please visit https://kagi.com/support

Overview

This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.

• API version: 0.1.0
• Package version: 0.1.0
• Generator version: 7.14.0-SNAPSHOT
• Build package: org.openapitools.codegen.languages.RustClientCodegen

Installation

Put the package under your project folder in a directory named openapi and add the following to Cargo.toml under [dependencies]:

openapi = { path = "./openapi" }

Documentation for API Endpoints

All URIs are relative to https://kagi.com/api/v1

Class	Method	HTTP request	Description
EnrichmentApi	enrich_search	GET /enrich/{type}	Get enriched search results
FastGptApi	fast_gpt	POST /fastgpt	Answer a query.
SearchApi	search	POST /search	Perform a search of the web.
SummarizerApi	summarize_text	POST /summarize	Upload text to summarize.
SummarizerApi	summarize_url	GET /summarize	Get a summary for a URL
TranslateApi	translate	POST /api/translate	Text Translation
TranslateApi	translate_alternatives	POST /alternative-translations	Alternative Translations
TranslateApi	translate_detect	POST /api/detect	Language Detection
TranslateApi	translate_dictionary	POST /api/dictionary	Dictionary
TranslateApi	translate_list_languages	GET /api/list-languages	List Supported Languages
TranslateApi	translate_romanize	GET /api/romanize	Text Romanization
TranslateApi	translate_word_insights	POST /api/word-insights	Word Insights

Documentation For Models

• EnrichSearch200Response
• ExampleError
• ExampleErrorError
• FastGpt200Response
• FastGpt200ResponseData
• FastGptRequest
• Meta
• Search200Response
• Search200ResponseData
• SearchObject
• SearchObjectImage
• SearchObjectThumbnail
• SearchRequest
• SearchResult
• SearchResultImage
• Summary
• SummaryData
• Translate200Response
• Translate200ResponseOneOf
• Translate200ResponseOneOf1
• Translate200ResponseOneOfDefinition
• Translate200ResponseOneOfDefinitionDefinitionsInner
• Translate200ResponseOneOfDefinitionDefinitionsInnerMeaningsInner
• Translate200ResponseOneOfDetectedLanguage
• Translate400Response
• Translate500Response
• TranslateAlternatives200Response
• TranslateAlternatives200ResponseElementsInner
• TranslateAlternatives401Response
• TranslateAlternatives402Response
• TranslateAlternatives500Response
• TranslateDetect200Response
• TranslateDetect400Response
• TranslateDetectRequest
• TranslateDictionary200Response
• TranslateDictionary200ResponseDefinition
• TranslateDictionary200ResponseDefinitionPrimaryMeaning
• TranslateDictionary200ResponseDefinitionSecondaryMeaningsInner
• TranslateDictionary200ResponseLanguage
• TranslateDictionary400Response
• TranslateDictionary500Response
• TranslateDictionaryRequest
• TranslateListLanguages200ResponseInner
• TranslateRequest
• TranslateRequestText
• TranslateRomanize200Response
• TranslateWordInsights200Response
• TranslateWordInsights200ResponseInsightsInner
• TranslateWordInsights200ResponseInsightsInnerVariationsInner
• TranslateWordInsights400Response
• TranslateWordInsights500Response
• UploadText

To get access to the crate's generated documentation, use:

cargo doc --open

Author

[email protected]