v1

latestOpenAPI 3.0.3MIT2026-07-137715.4 KB

Get API metadata and discovery information

Returns metadata about the API including available endpoints, version information, and links to documentation. This endpoint is useful for API discovery and provides a quick overview of all available endpoints.

get/

Response

OK - Returns API metadata

namestring
versionstring
descriptionstring
documentationstring
sourcestring

Example response

{
  "name": "Color Name API",
  "version": "v1",
  "description": "API for getting human-friendly names for hex colors",
  "endpoints": {
    "colors": "/v1/?values=ff0000,00ff00",
    "colorsByPath": "/v1/ff0000,00ff00",
    "names": "/v1/names/:query",
    "lists": "/v1/lists/",
    "swatch": "/v1/swatch/?color=ff0000&name=Red",
    "docs": "/v1/docs/",
    "health": "/health"
  },
  "documentation": "/openapi.yaml",
  "source": "https://github.com/meodai/color-name-api"
}
All 7 operations