Spec

Codefragmenten

curl "https://api.oanor.com/highlight-api/v1/meta" \
  -H "x-oanor-key: oanor_test_..."

await fetch("https://api.oanor.com/highlight-api/v1/meta", {
  headers: { "x-oanor-key": "oanor_test_..." }
});

$ch = curl_init("https://api.oanor.com/highlight-api/v1/meta");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["x-oanor-key: oanor_test_..."]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$out = curl_exec($ch);

import requests
requests.get(
    "https://api.oanor.com/highlight-api/v1/meta",
    headers={"x-oanor-key": "oanor_test_..."}
)

Voorbeeldrespons

Een echte respons van dit endpoint, vastgelegd bij de laatste health check.

{
    "data": {
        "name": "Highlight API",
        "notes": "Terms are matched literally (regex characters are escaped). The markers are inserted as-is — pick HTML-safe markers if you will render the result as HTML. Nothing is stored.",
        "version": "v1",
        "endpoints": [
            {
                "path": "/v1/highlight",
                "params": {
                    "open": "marker start (default <mark>)",
                    "text": "the text (required)",
                    "close": "marker end (default </mark>)",
                    "query": "a term or comma-separated terms (required)",
                    "whole_word": "true/false",
                    "case_insensitive": "default true"
                },
                "returns": "the highlighted text and match count"
            },
            {
                "path": "/v1/snippets",
                "params": {
                    "text": "the text (required)",
                    "query": "terms (required)",
                    "context": "chars of context each side (default 40)"
                },
                "returns": "a snippet around each match"
            },
            {
                "path": "/v1/meta",
                "params": [],
                "returns": "this document"
            }
        ],
        "description": "Highlight one or more search terms in text by wrapping every match in a marker (defaults to <mark>…</mark>, or any open/close strings you choose), and extract short snippets of surrounding context around each match — the way a search-results page shows matches. Case-insensitive by default, with optional whole-word matching. Pure local, no key."
    },
    "meta": {
        "timestamp": "2026-06-03T09:25:08.850Z",
        "request_id": "5d1e81d1-0388-4385-9dd2-bb7e6627eb8f"
    },
    "status": "ok",
    "message": "Meta",
    "success": true
}