API reference

Docs

Semantic search over the MailKite documentation — the same index the docs' ⌘K palette uses.

Auth: Public · Base URL: https://api.mailkite.dev

Endpoints

Each row expands to its request and response schema. The address bar follows along, so any endpoint can be linked to directly.

GET /v1/docs/search Semantic search over the MailKite documentation — returns the most relevant doc sections for a natural-language query (hybrid vector + keyword search over https://mailkite.dev/docs). Public; no authentication required.

Semantic search over the MailKite documentation — returns the most relevant doc sections for a natural-language query (hybrid vector + keyword search over https://mailkite.dev/docs). Public; no authentication required.

Response body

semantic-search-response.json

Field	Type	Notes
query req	string	The query that was searched.
matches req	object[]	Most-relevant documentation sections, best first.
matches[].slug req	string	Doc slug — the page lives at https://mailkite.dev/docs/<slug> (e.g. "quickstart", "domains").
matches[].title req	string	Human page title.
matches[].section	string	Doc section/category.
matches[].snippet req	string	A relevant excerpt from the matched section.
matches[].score	number	Relevance score (higher is closer); absent for lexical-only matches.

An actual response, recorded from the conformance suite.

response.json

{
  "query": "domains",
  "matches": [
    {
      "slug": "domains",
      "title": "Domains & DNS",
      "section": "website",
      "snippet": "Add a domain, set DNS, and verify."
    }
  ]
}

semantic-search-response.json

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://api.mailkite.dev/v1/schemas/semantic-search-response.json",
  "title": "Semantic docs search response",
  "type": "object",
  "required": [
    "query",
    "matches"
  ],
  "properties": {
    "query": {
      "type": "string",
      "description": "The query that was searched."
    },
    "matches": {
      "type": "array",
      "description": "Most-relevant documentation sections, best first.",
      "items": {
        "type": "object",
        "required": [
          "slug",
          "title",
          "snippet"
        ],
        "properties": {
          "slug": {
            "type": "string",
            "description": "Doc slug — the page lives at https://mailkite.dev/docs/<slug> (e.g. \"quickstart\", \"domains\")."
          },
          "title": {
            "type": "string",
            "description": "Human page title."
          },
          "section": {
            "type": "string",
            "description": "Doc section/category."
          },
          "snippet": {
            "type": "string",
            "description": "A relevant excerpt from the matched section."
          },
          "score": {
            "type": "number",
            "description": "Relevance score (higher is closer); absent for lexical-only matches."
          }
        }
      }
    }
  }
}