Docs / Developers

Hyperwave developer tools

Use Hyperwave's public developer tools to find wavetable import instructions, read source-linked format documentation, and calculate packed float32 mono WAV sizes. Documentation and format utilities are anonymous and read-only. Temporary collaborative sessions let agents create and edit presets with users and render bounded audio using the shipped WASM engine. Session operations use a private workspace token and cannot access unrelated local or cloud projects.

Session workflow: create_session returns a private editor link and token; describe_nodes discovers templates and controls; read_session supplies the current revision; edit_session applies atomic changes using stable node ids. Conflicting fields return HTTP 409 and require rereading. checkpoint_session and restore_session manage shared versions, wait_for_changes receives user edits, render_session returns preview/WAV/preset downloads, and close_session deletes the workspace. Workspaces expire after 24 hours.

The REST interface accepts JSON POST requests under /api/v1/agent; the original /api/agent aliases remain supported. The OpenAPI specification describes every input, response, and error. Start product capability questions with appfeatures: POST {} to /api/v1/agent/appfeatures, or call appfeatures on /mcp. It returns the current generation features, how to use them, limitations, edition prices and availability, and links to /features and the documentation. An optional category filters the feature list. Use search_docs to find published pages, get_document to retrieve Markdown, list_export_targets to check import requirements, calculate_frame_size to compute float32 mono WAV sizes, and describe_wav_encoding to inspect the actual float32 or pcm16 encoder layout. Some hardware needs PCM or vendor conversion.

MCP clients can connect using Streamable HTTP to /mcp for collaborative sessions, rendering, export targets and calculations, or /mcp/docs for documentation search and retrieval. The calculator also provides an MCP Apps interface in clients that support it. The same documentation search is available through the NLWeb /ask endpoint with JSON or Server-Sent Events. Search retrieves published material; it does not generate answers with an LLM.

Fetch /index.md for a Markdown overview, append .md to a public content URL for its text representation, or request a public page with Accept: text/markdown. A request to /?mode=agent also returns Markdown. These representations summarize the public page and use the same content registries as the site. Public page URLs serve HTML by default to browsers and AI crawlers, preserving structured data and normal search-reader compatibility. Markdown is selected explicitly, never by User-Agent. Discovery links are published in llms.txt, the API catalog, ARD catalog, and Agent Skills index.

Try a calculation with samplesPerFrame 2048, frameCount 256, and sampleRate 48000 on the public endpoint. These read-only utility examples leave projects untouched. For collaborative editing, create_session returns an editorUrl and private token. Open the link to join the same project; the Temporary session badge opens the normal Save as preset dialog. In browsers with WebMCP, a small standalone script registers the same public tools without waiting for React hydration.

API version 1 is stable; optional API-Version: 1 is echoed in responses. Breaking changes use a new major URL. Any future v1 retirement will be announced in these docs at least 90 days ahead with Deprecation and Sunset headers; none is scheduled. Search and target lists return next_cursor, has_more, and total. Reuse the returned cursor with identical filters. POST /api/v1/agent/batch accepts up to 20 independent operations with unique IDs and per-operation status/data/error. Utility operations are idempotent; session mutations are revision-checked and must not be blindly retried after an uncertain response. wait_for_changes waits up to 20 seconds.

REST quotas are best-effort: 120 requests per client per 60 seconds within each server process, with transient hashed-client counters. Responses report RateLimit-Policy and RateLimit, compatibility RateLimit-Limit/Remaining/Reset fields, and API-Version. A 429 includes Retry-After in seconds. Counters are not shared across instances and are not a distributed quota guarantee. No request bodies are retained by these counters. JavaScript/TypeScript and Python clients plus a Node CLI are available as direct downloads; npm/PyPI registry publication is separate.

The official integrations repository at https://github.com/roguefort-dev/hyperwave-agents contains maintained skills, AGENTS.md, plugin and MCP configuration, and JavaScript/TypeScript and Python client sources. Install the skills with npx skills add roguefort-dev/hyperwave-agents.