Lumi API documentation
This page describes available API routes on this domain for integrators and automated agents. Start with the API catalog to discover the published documents. Use the OpenAPI file as a route and method overview, not as a complete client contract.
Available API documents
- Agent capability catalog(application/json)
- Agent skills discovery index(application/json with SHA-256 artifact digests)
- Authentication and agent access(text/markdown)
- API catalog (RFC 9727 Linkset)(application/linkset+json)
- OpenAPI overview(application/json (OpenAPI 3.1))
Use the documents in two steps
- Read the API catalog to find the current discovery and service-description links.
- Read the OpenAPI file to see the listed routes and HTTP methods. Confirm current request and response details before you build a client.
These documents cover Lumi's public site APIs. They do not expose the installed Shopify app, partner dashboard, merchant data, or private administration routes.
Know the route overview's limits
The OpenAPI file does not yet define every request field, response shape, authentication rule, or error status. Confirm the current endpoint behavior before you send production traffic. Do not depend on fields that appear only in an example or webpage.
The catalog and OpenAPI responses are machine-readable and may be cached. Follow their response headers when deciding when to fetch a fresh copy. Check the overview again when you update an integration. Both documents are public, so clients can read them without a merchant account or Shopify installation.
Agent access and browser tools
In browsers that support WebMCP, get_lumi_resources lists public resources and open_lumi_page opens a public tool or information page. These actions do not submit forms, start scans, install Lumi, or purchase a plan. Public tools keep their existing validation and abuse protections.
This domain does not offer programmatic agent registration, delegated OAuth access, an MCP server, or agent payment and checkout APIs. Partners use interactive Clerk sign-in. Merchants install and authorize Lumi through Shopify. Read auth.md before accessing account features.