Kagi API (1)

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.

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.

API Status

The v1 API is currently in preview to early access testers.

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

See our API Pricing page for standard rates.

GitHub Discussions

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

Discord

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

Download OpenAPI description

openapi.json

openapi.yaml

Overview

URL

https://kagi.com/support

API Support

support@kagi.com

License

Apache-2.0

Servers

Mock server

https://redocly-api-docs.kagi.com/_mock/openapi/

Production api endpoint

https://kagi.com/api/v1/

Search API

The Search API is a feature-rich endpoint for search products and agents. It gives programmable access to Kagi's premium search results pulled from many different sources - including our in-house indexes - and re-ranked to surface accurate answers and interesting finds. You can read about our approach towards search on our blog.

The API supports most of the features that we offer through our web UI, including Lenses.

You can also request full markdown extraction of the top results in a single API request.

Operations

Extract API

Extract contents from web pages, currently in markdown form. This endpoint accepts a list of URLs and returns the extracted markdown content for each page.

Operations

Extract page content as markdown from URLs

Request

Extracts markdown content from up to 10 HTTP(s) URLs. Each URL is processed and the extracted content is returned in the response.

Security

kagi

Bodyapplication/jsonrequired

pagesArray of objects(pageInput)[ 1 .. 10 ] itemsrequired

Array of pages to extract content from. Must contain 1-10 URLs. Each URL must be a valid HTTPS URL.

pages[].urlstring(uri)required

The HTTPS URL of the page to extract content from. Must use HTTPS scheme with a valid host.

Example: "https://example.com/article"

timeoutnumber(float)[ 0.5 .. 10 ]

Optional timeout in seconds for the extraction operation. Out of range values will be clamped back within range.

All URLs are fetched concurrently. This timeout applies a time budget for the entire bulk fetch operation.

Example: 1.337

formatstring

(EXPERIMENTAL) Format to serialize the API response as. The exact contents and structure of markdown output is still being worked on - please send your feedback!

Default "json"

Enum"json""markdown"

curl -i -X POST \
  https://redocly-api-docs.kagi.com/_mock/openapi/extract \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "pages": [
      {
        "url": "https://example.com/article1"
      },
      {
        "url": "https://example.com/article2"
      }
    ],
    "timeout": 1.337,
    "format": "json"
  }'

Responses

Successful extraction

Body

metaobject(meta)required

This object is subject to change as it is provided for debugging purposes. Fields may be added or removed as required. Don't build any hard dependancies on any of this data.

meta.tracestring

Trace ID that can be used to debug individual API requests. Provide this, if needed, when contacting Kagi support.

meta.nodestring

The hostname of the node that fulfilled the request.

meta.msinteger

how long the request took to fulfill, excluding round trip to the client.

meta.property name*anyadditional property

dataArray of objects(pageOutput)required

Array of extracted page content

data[].urlstring(uri)required

The URL of the extracted page

Example: "https://example.com/article"

data[].markdownstring or null

Extracted markdown content of the page

Example: "# Article Title\n\nThis is the extracted content..."

errorsArray of objects(errorDetail)

Optional array of errors that occurred during extraction

Response

{
  "meta": {
    "trace": "abc123def456",
    "ms": 1250,
    "node": "us-east-1"
  },
  "data": [
    { … }
  ]
}