Skip to main content

Using the OpenAPI Schema

This reference site is generated from the same OpenAPI 3.0 description that powers the HeliumGeek platform. You can reuse that schema to build type-safe clients, generate validators, or integrate with automation workflows.

Download the schema​

Download the schema straight from the docs host:

curl -L https://docs.heliumgeek.com/openapi/heliumgeek.json -o heliumgeek.json

The file is regenerated as part of each documentation publish, so it always represents the latest public contract.

Generate SDKs​

Point your preferred generator at the file you downloaded:

npx openapi-typescript heliumgeek.json -o src/generated/helium.ts

These clients mirror the exposed REST contract. Apply your usual static-analysis or linting rules (for example, noImplicitReturns, noUnusedLocals) when you integrate the generated code into your project.

Feed LLM coding agents​

  • Supply the raw JSON file to an agent so it can reason about endpoints and schemas.
  • Pair the schema with the narrative guides in this site to keep prompts concise.
  • Fetch the machine-readable catalog at /meta/index.json to give tools like Codex, Claude Code, and Cursor quick access to guide and endpoint summaries without crawling.
  • Cache the /openapi/heliumgeek.json URL in your automation so you always reference the current contract.

Need inspiration? Check out the API Reference sidebar to see how each endpoint is documented from the same source.