Skip to content

kagisearch/kagi-openapi-rust

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

28 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Rust API client for kagi-openapi-rust

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

Get started on the API Dashboard to set up billing, manage API keys, and more.

See our API Pricing page for standard rates.

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.

In the future we will most likely offer more crafted API wrappers and spotlight clients and applications built by our community - feel free to send them to us!

MCP

We offer a hosted MCP server at: https://mcp.kagi.com/mcp

At this time, we do not support setup via OAuth2 flow, but this is on our roadmap. You will need to get your API key from the dashboard and plug it into your local client with Bearer HTTP authentication.

Here is an example to get started with Claude Code:

claude mcp add kagi https://mcp.kagi.com/mcp --transport http --header \"Authorization: Bearer $(read -sp 'API key: ' k; echo $k)\" --scope user

You can review and contribute to our MCP server on GitHub!

Support

For bug reports, feature requests, or billing related issues please reach out to developers@kagi.com and we will be happy to assist you.

To help us answer your reports efficiently, please be prepared to provide as much info as you can:

  • For bugs, include request trace IDs from the meta.trace response field or the X-Kagi-Trace response header.
  • If issues are easily reproduced in our playground, send us a link to the playground - the URL will contain parameters to configure the request so that we can reproduce ourselves.
  • Include any code snippets or precise descriptions of the request you are making, and full samples of the response bodies from the API
  • Include mention of which wrapper you are using if any, or links to relevant application code we can review
  • Include the email address associated with your Kagi login if it is not the one you are emailing from

Thank you!

Discord

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

In the server you will find the #api forum for API related inquiries.

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: 1
  • Package version: 1
  • Generator version: 7.22.0-SNAPSHOT
  • Build package: org.openapitools.codegen.languages.RustClientCodegen

Installation

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

kagi-openapi-rust = { path = "./kagi-openapi-rust" }

Documentation for API Endpoints

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

Class Method HTTP request Description
ExtractApi extract_content POST /extract Extract page content as markdown from URLs
SearchApi search POST /search Perform a web search

Documentation For Models

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

cargo doc --open

Author

developers@kagi.com

About

OpenAPI generated rust client for interacting with the Kagi API

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors