Search

Perform a web search

post/search

Request

  • Base URL: https://kagi.com/api/v1
  • URL: https://kagi.com/api/v1/search
  • Auth: HTTP bearer

Request body

querystring required

Search query to run.

workflow'search' | 'images' | 'videos' | 'news' | 'podcasts'

Type of results to return.

format'json' | 'markdown'

(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!

lens_idstring

Lens to apply to the search. Can be a built-in lens's identifier or a lens ID as shown on https://kagi.com/settings/lenses when a lens is set to be shareable. Can be just the ID portion of the URL (https://kagi.com/lenses/ID) or the full URL.

timeoutnumber

Number of seconds to allow for collecting search results. Lower values will return results more quickly, but may be lower quality or inconsistent between calls. If omitted, will use the latest recommended value by Kagi.

pageinteger

Page number for paginated results. Must be between 1 and 10.

limitinteger

Maximum number of results to return. Must be between 1 and 1024. NOTE: This does not change the amount of results requested, it only limits the maximum amount returned. If omitted, the API always gives you the most results we can get in a single pass.

safe_searchboolean

Whether safe search is enabled, omitting potentially NSFW content.

Example request

{
  "personalizations": {
    "regexes": [
      {
        "regex": "^https?://(www\\.)?reddit\\.com.*",
        "replacement": "https://old.reddit.com"
      }
    ]
  }
}

Response

Success

Example response

{
  "data": {
    "search": [
      {
        "url": "https://en.wikipedia.org/wiki/Steve_Jobs",
        "title": "Steve Jobs - Wikipedia",
        "snippet": "Steven Paul Jobs (February 24, 1955 – October 5, 2011) was an American businessman, inventor, and investor best known for co-founding the ...",
        "time": "2024-11-29T03:54:26Z",
        "image": {
          "url": "https://upload.wikimedia.org/wikipedia/commons/thumb/d/dc/Steve_Jobs_Headshot_2010-CROP_%28cropped_2%29.jpg/330px-Steve_Jobs_Headshot_2010-CROP_%28cropp    ed_2%29.jpg",
          "height": 300,
          "width": 310
        }
      }
    ],
    "image": [
      {
        "url": "https://en.wikipedia.org/wiki/Steve_Jobs",
        "title": "Steve Jobs - Wikipedia",
        "snippet": "Steven Paul Jobs (February 24, 1955 – October 5, 2011) was an American businessman, inventor, and investor best known for co-founding the ...",
        "time": "2024-11-29T03:54:26Z",
        "image": {
          "url": "https://upload.wikimedia.org/wikipedia/commons/thumb/d/dc/Steve_Jobs_Headshot_2010-CROP_%28cropped_2%29.jpg/330px-Steve_Jobs_Headshot_2010-CROP_%28cropp    ed_2%29.jpg",
          "height": 300,
          "width": 310
        }
      }
    ],
    "video": [
      {
        "url": "https://en.wikipedia.org/wiki/Steve_Jobs",
        "title": "Steve Jobs - Wikipedia",
        "snippet": "Steven Paul Jobs (February 24, 1955 – October 5, 2011) was an American businessman, inventor, and investor best known for co-founding the ...",
        "time": "2024-11-29T03:54:26Z",
        "image": {
          "url": "https://upload.wikimedia.org/wikipedia/commons/thumb/d/dc/Steve_Jobs_Headshot_2010-CROP_%28cropped_2%29.jpg/330px-Steve_Jobs_Headshot_2010-CROP_%28cropp    ed_2%29.jpg",
          "height": 300,
          "width": 310
        }
      }
    ],
    "podcast": [
      {
        "url": "https://en.wikipedia.org/wiki/Steve_Jobs",
        "title": "Steve Jobs - Wikipedia",
        "snippet": "Steven Paul Jobs (February 24, 1955 – October 5, 2011) was an American businessman, inventor, and investor best known for co-founding the ...",
        "time": "2024-11-29T03:54:26Z",
        "image": {
          "url": "https://upload.wikimedia.org/wikipedia/commons/thumb/d/dc/Steve_Jobs_Headshot_2010-CROP_%28cropped_2%29.jpg/330px-Steve_Jobs_Headshot_2010-CROP_%28cropp    ed_2%29.jpg",
          "height": 300,
          "width": 310
        }
      }
    ],
    "podcast_creator": [
      {
        "url": "https://en.wikipedia.org/wiki/Steve_Jobs",
        "title": "Steve Jobs - Wikipedia",
        "snippet": "Steven Paul Jobs (February 24, 1955 – October 5, 2011) was an American businessman, inventor, and investor best known for co-founding the ...",
        "time": "2024-11-29T03:54:26Z",
        "image": {
          "url": "https://upload.wikimedia.org/wikipedia/commons/thumb/d/dc/Steve_Jobs_Headshot_2010-CROP_%28cropped_2%29.jpg/330px-Steve_Jobs_Headshot_2010-CROP_%28cropp    ed_2%29.jpg",
          "height": 300,
          "width": 310
        }
      }
    ],
    "news": [
      {
        "url": "https://en.wikipedia.org/wiki/Steve_Jobs",
        "title": "Steve Jobs - Wikipedia",
        "snippet": "Steven Paul Jobs (February 24, 1955 – October 5, 2011) was an American businessman, inventor, and investor best known for co-founding the ...",
        "time": "2024-11-29T03:54:26Z",
        "image": {
          "url": "https://upload.wikimedia.org/wikipedia/commons/thumb/d/dc/Steve_Jobs_Headshot_2010-CROP_%28cropped_2%29.jpg/330px-Steve_Jobs_Headshot_2010-CROP_%28cropp    ed_2%29.jpg",
          "height": 300,
          "width": 310
        }
      }
    ],
    "adjacent_question": [
      {
        "url": "https://en.wikipedia.org/wiki/Steve_Jobs",
        "title": "Steve Jobs - Wikipedia",
        "snippet": "Steven Paul Jobs (February 24, 1955 – October 5, 2011) was an American businessman, inventor, and investor best known for co-founding the ...",
        "time": "2024-11-29T03:54:26Z",
        "image": {
          "url": "https://upload.wikimedia.org/wikipedia/commons/thumb/d/dc/Steve_Jobs_Headshot_2010-CROP_%28cropped_2%29.jpg/330px-Steve_Jobs_Headshot_2010-CROP_%28cropp    ed_2%29.jpg",
          "height": 300,
          "width": 310
        }
      }
    ],
    "direct_answer": [
      {
        "url": "https://en.wikipedia.org/wiki/Steve_Jobs",
        "title": "Steve Jobs - Wikipedia",
        "snippet": "Steven Paul Jobs (February 24, 1955 – October 5, 2011) was an American businessman, inventor, and investor best known for co-founding the ...",
        "time": "2024-11-29T03:54:26Z",
        "image": {
          "url": "https://upload.wikimedia.org/wikipedia/commons/thumb/d/dc/Steve_Jobs_Headshot_2010-CROP_%28cropped_2%29.jpg/330px-Steve_Jobs_Headshot_2010-CROP_%28cropp    ed_2%29.jpg",
          "height": 300,
          "width": 310
        }
      }
    ],
    "interesting_news": [
      {
        "url": "https://en.wikipedia.org/wiki/Steve_Jobs",
        "title": "Steve Jobs - Wikipedia",
        "snippet": "Steven Paul Jobs (February 24, 1955 – October 5, 2011) was an American businessman, inventor, and investor best known for co-founding the ...",
        "time": "2024-11-29T03:54:26Z",
        "image": {
          "url": "https://upload.wikimedia.org/wikipedia/commons/thumb/d/dc/Steve_Jobs_Headshot_2010-CROP_%28cropped_2%29.jpg/330px-Steve_Jobs_Headshot_2010-CROP_%28cropp    ed_2%29.jpg",
          "height": 300,
          "width": 310
        }
      }
    ],
    "interesting_finds": [
      {
        "url": "https://en.wikipedia.org/wiki/Steve_Jobs",
        "title": "Steve Jobs - Wikipedia",
        "snippet": "Steven Paul Jobs (February 24, 1955 – October 5, 2011) was an American businessman, inventor, and investor best known for co-founding the ...",
        "time": "2024-11-29T03:54:26Z",
        "image": {
          "url": "https://upload.wikimedia.org/wikipedia/commons/thumb/d/dc/Steve_Jobs_Headshot_2010-CROP_%28cropped_2%29.jpg/330px-Steve_Jobs_Headshot_2010-CROP_%28cropp    ed_2%29.jpg",
          "height": 300,
          "width": 310
        }
      }
    ],
    "infobox": [
      {
        "url": "https://en.wikipedia.org/wiki/Steve_Jobs",
        "title": "Steve Jobs - Wikipedia",
        "snippet": "Steven Paul Jobs (February 24, 1955 – October 5, 2011) was an American businessman, inventor, and investor best known for co-founding the ...",
        "time": "2024-11-29T03:54:26Z",
        "image": {
          "url": "https://upload.wikimedia.org/wikipedia/commons/thumb/d/dc/Steve_Jobs_Headshot_2010-CROP_%28cropped_2%29.jpg/330px-Steve_Jobs_Headshot_2010-CROP_%28cropp    ed_2%29.jpg",
          "height": 300,
          "width": 310
        }
      }
    ],
    "code": [
      {
        "url": "https://en.wikipedia.org/wiki/Steve_Jobs",
        "title": "Steve Jobs - Wikipedia",
        "snippet": "Steven Paul Jobs (February 24, 1955 – October 5, 2011) was an American businessman, inventor, and investor best known for co-founding the ...",
        "time": "2024-11-29T03:54:26Z",
        "image": {
          "url": "https://upload.wikimedia.org/wikipedia/commons/thumb/d/dc/Steve_Jobs_Headshot_2010-CROP_%28cropped_2%29.jpg/330px-Steve_Jobs_Headshot_2010-CROP_%28cropp    ed_2%29.jpg",
          "height": 300,
          "width": 310
        }
      }
    ],
    "package_tracking": [
      {
        "url": "https://en.wikipedia.org/wiki/Steve_Jobs",
        "title": "Steve Jobs - Wikipedia",
        "snippet": "Steven Paul Jobs (February 24, 1955 – October 5, 2011) was an American businessman, inventor, and investor best known for co-founding the ...",
        "time": "2024-11-29T03:54:26Z",
        "image": {
          "url": "https://upload.wikimedia.org/wikipedia/commons/thumb/d/dc/Steve_Jobs_Headshot_2010-CROP_%28cropped_2%29.jpg/330px-Steve_Jobs_Headshot_2010-CROP_%28cropp    ed_2%29.jpg",
          "height": 300,
          "width": 310
        }
      }
    ],
    "public_records": [
      {
        "url": "https://en.wikipedia.org/wiki/Steve_Jobs",
        "title": "Steve Jobs - Wikipedia",
        "snippet": "Steven Paul Jobs (February 24, 1955 – October 5, 2011) was an American businessman, inventor, and investor best known for co-founding the ...",
        "time": "2024-11-29T03:54:26Z",
        "image": {
          "url": "https://upload.wikimedia.org/wikipedia/commons/thumb/d/dc/Steve_Jobs_Headshot_2010-CROP_%28cropped_2%29.jpg/330px-Steve_Jobs_Headshot_2010-CROP_%28cropp    ed_2%29.jpg",
          "height": 300,
          "width": 310
        }
      }
    ],
    "weather": [
      {
        "url": "https://en.wikipedia.org/wiki/Steve_Jobs",
        "title": "Steve Jobs - Wikipedia",
        "snippet": "Steven Paul Jobs (February 24, 1955 – October 5, 2011) was an American businessman, inventor, and investor best known for co-founding the ...",
        "time": "2024-11-29T03:54:26Z",
        "image": {
          "url": "https://upload.wikimedia.org/wikipedia/commons/thumb/d/dc/Steve_Jobs_Headshot_2010-CROP_%28cropped_2%29.jpg/330px-Steve_Jobs_Headshot_2010-CROP_%28cropp    ed_2%29.jpg",
          "height": 300,
          "width": 310
        }
      }
    ],
    "related_search": [
      {
        "url": "https://en.wikipedia.org/wiki/Steve_Jobs",
        "title": "Steve Jobs - Wikipedia",
        "snippet": "Steven Paul Jobs (February 24, 1955 – October 5, 2011) was an American businessman, inventor, and investor best known for co-founding the ...",
        "time": "2024-11-29T03:54:26Z",
        "image": {
          "url": "https://upload.wikimedia.org/wikipedia/commons/thumb/d/dc/Steve_Jobs_Headshot_2010-CROP_%28cropped_2%29.jpg/330px-Steve_Jobs_Headshot_2010-CROP_%28cropp    ed_2%29.jpg",
          "height": 300,
          "width": 310
        }
      }
    ],
    "listicle": [
      {
        "url": "https://en.wikipedia.org/wiki/Steve_Jobs",
        "title": "Steve Jobs - Wikipedia",
        "snippet": "Steven Paul Jobs (February 24, 1955 – October 5, 2011) was an American businessman, inventor, and investor best known for co-founding the ...",
        "time": "2024-11-29T03:54:26Z",
        "image": {
          "url": "https://upload.wikimedia.org/wikipedia/commons/thumb/d/dc/Steve_Jobs_Headshot_2010-CROP_%28cropped_2%29.jpg/330px-Steve_Jobs_Headshot_2010-CROP_%28cropp    ed_2%29.jpg",
          "height": 300,
          "width": 310
        }
      }
    ],
    "web_archive": [
      {
        "url": "https://en.wikipedia.org/wiki/Steve_Jobs",
        "title": "Steve Jobs - Wikipedia",
        "snippet": "Steven Paul Jobs (February 24, 1955 – October 5, 2011) was an American businessman, inventor, and investor best known for co-founding the ...",
        "time": "2024-11-29T03:54:26Z",
        "image": {
          "url": "https://upload.wikimedia.org/wikipedia/commons/thumb/d/dc/Steve_Jobs_Headshot_2010-CROP_%28cropped_2%29.jpg/330px-Steve_Jobs_Headshot_2010-CROP_%28cropp    ed_2%29.jpg",
          "height": 300,
          "width": 310
        }
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.