GET openapi.json

Endpoint

GET /public-api/v1/openapi.json

Purpose

Returns the OpenAPI description for the Public API. Use it to inspect paths, generate clients, or import the API into tools.

Authentication

No authentication is required.

Parameters

None.

Response fields

The response is an OpenAPI 3.0.3 document with info, servers, components, security, and paths.

Example request

curl https://api.klupos.com/public-api/v1/openapi.json

Example response

{
  "openapi": "3.0.3",
  "info": {
    "title": "Klu POS Public API",
    "version": "1.1.0"
  },
  "paths": {
    "/me": {
      "get": {
        "summary": "Get API key and organization metadata"
      }
    }
  }
}

Common errors

This endpoint should normally return 200. If unavailable, treat it as a service availability problem.

AI-agent notes

Use this endpoint as the contract source of truth. Do not infer undocumented write methods; this API is read-only.