Spec

Code snippets

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

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

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

Example response

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

{
    "data": {
        "notes": "Grams, litres, % on-weight-of-fabric. dye = WOF·shade%; bath_L = WOF_kg·ratio; auxiliary = bath_L·g/L. Recipes scale because everything is on-weight or per-litre. For fibre/yarn amounts use a knitting API.",
        "service": "dye-api",
        "endpoints": {
            "GET /v1/meta": "This document.",
            "GET /v1/auxiliary": "Salt/soda/auxiliary amount from bath volume and g/L.",
            "GET /v1/dye-weight": "Dye weight from fabric weight and depth of shade.",
            "GET /v1/liquor-ratio": "Dye-bath volume from fabric weight and liquor ratio."
        },
        "description": "Textile dyeing recipe maths: dye weight from depth of shade, bath volume from liquor ratio, and auxiliary amount from bath concentration."
    },
    "meta": {
        "timestamp": "2026-06-07T08:17:56.450Z",
        "request_id": "6c4e8690-2704-4593-8120-62c46ae7d831"
    },
    "status": "ok",
    "message": "Meta",
    "success": true
}