Skip to Content
API referenceAPI reference

Developer reference

API reference

Start with authentication, scopes and request conventions for Helm’s registered HTTP API.

Helm’s API is rooted at /api/v1. The financial surface uses /api/v1/v2. Use the canonical application origin, https://helm.neuroom.io, for the public product.

Make your first read

Start with the read-only quickstart. It creates a minimum-scope user token and requests the caller’s accounts. Do not use a privileged database key as an integration credential.

Reference map

NeedRead
Identify the callerAuthentication and API tokens.
Choose permissionsScopes.
Parse responsesConventions, errors and pagination.
Recover a money commandIdempotency.
Find a method and pathRegistered endpoint catalog.
Build a clientClient integration and rate limits.

Contract boundaries

Resource IDs must belong to the authenticated user. The registered operation list states methods and scopes; request validation and financial constraints still apply. Some first-party read branches are not part of the API-token registry.

This API is coupled to the deployed Helm version. A machine-readable manifest does not establish a hosted MCP transport or every future integration. Read current boundaries before depending on a planned capability.