Spec

Code snippets

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

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

$ch = curl_init("https://api.oanor.com/maze-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/maze-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": "Maze API",
        "notes": "Mazes are 'perfect' (no loops, one unique route). Pass the same seed, width, height and algorithm to generate and solve to get matching mazes. Grid bitmask bits: 1=N wall, 2=E, 4=S, 8=W. Nothing is stored.",
        "version": "v1",
        "endpoints": [
            {
                "path": "/v1/generate",
                "params": {
                    "seed": "integer for a reproducible maze (random if omitted)",
                    "width": "cells wide (2–40, default 10)",
                    "height": "cells tall (2–40, default 10)",
                    "algorithm": "backtracker (default) or prim"
                },
                "returns": "the maze as ASCII and a wall-bitmask grid, plus the seed"
            },
            {
                "path": "/v1/solve",
                "params": {
                    "seed": "the seed of the maze to solve (required to match a generated one)",
                    "width": "as generate",
                    "height": "as generate",
                    "algorithm": "as generate"
                },
                "returns": "the shortest path from start to end and the solved ASCII"
            },
            {
                "path": "/v1/meta",
                "params": [],
                "returns": "this document"
            }
        ],
        "description": "Generate and solve mazes. The generate endpoint builds a perfect maze (exactly one path between any two cells) of the width and height you choose, using a recursive-backtracker (long winding corridors) or Prim's algorithm (more branching), and returns it as ready-to-print ASCII art plus a compact per-cell wall grid, with the start (top-left) and end (bottom-right) marked. Every maze is reproducible: pass a seed and you always get the same maze, so the solve endpoint re-creates it from the same seed and returns the shortest path from start to finish, both as a list of cells and drawn onto the maze. Pure local, no key."
    },
    "meta": {
        "timestamp": "2026-06-03T09:24:59.554Z",
        "request_id": "b810ee48-f105-4d9f-bd5d-17aea4e25a59"
    },
    "status": "ok",
    "message": "Meta",
    "success": true
}