Spec

Code snippets

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

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

$ch = curl_init("https://api.oanor.com/initials-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/initials-api/v1/meta",
    headers={"x-oanor-key": "oanor_test_..."}
)

Example response

A real response from this endpoint, captured by the latest health check.

{
    "data": {
        "name": "Initials API",
        "notes": "Particles are skipped only when at least one other word remains. Hyphenated names contribute each part to initials (Jean-Luc → J, L) but count as one word for the monogram. Nothing is stored.",
        "version": "v1",
        "endpoints": [
            {
                "path": "/v1/initials",
                "params": {
                    "max": "cap the number of initials (default all)",
                    "value": "the name or phrase (required)",
                    "dotted": "true for J.D. form",
                    "separator": "string between initials (default none)",
                    "uppercase": "default true",
                    "skip_particles": "skip van/von/de/la… (default true)"
                },
                "returns": "the initials string, the letters and a count"
            },
            {
                "path": "/v1/monogram",
                "params": {
                    "value": "the name (required)",
                    "length": "1, 2 or 3 letters (default 2)",
                    "uppercase": "default true",
                    "skip_particles": "skip particles (default true)"
                },
                "returns": "the avatar monogram (e.g. JD)"
            },
            {
                "path": "/v1/meta",
                "params": [],
                "returns": "this document"
            }
        ],
        "description": "Extract initials and avatar monograms from a name or phrase. The initials endpoint returns the first letter of every significant word — skipping lower-case nobiliary particles (van, von, de, la, der, of, the…) by default — with options for a separator, dotted form (J.D.), upper- or original case, and a maximum count. The monogram endpoint returns the short one-, two- or three-letter badge initials used for UI avatars (John Michael Doe → JD), taking the first and last significant words. Multibyte-safe so accented and non-Latin letters work. Pure local, no key."
    },
    "meta": {
        "timestamp": "2026-06-03T09:25:06.799Z",
        "request_id": "f4d3fd50-4b45-4f9a-aae8-ead3de766230"
    },
    "status": "ok",
    "message": "Meta",
    "success": true
}