Skip to main content
The RinkNotes API will turn a coach’s spoken bench notes and game audio into structured hockey data — classified player observations, game stats, and schedule items — programmatically. This page is a high-level map of that planned surface, meant to give partners a feel for the shape of the API and a place to tell us what’s missing.
The developer API isn’t commercially available yet. Everything below is preview or roadmap. The preview surfaces are grounded in capabilities that already power the RinkNotes app internally, so the shapes are real — but they aren’t commercially available to external developers today. We’re shaping this with early partners. If you’d integrate with RinkNotes, tell us what you need — it directly informs the design.

What it will let you do

Capture

Send a typed note or an audio clip and get it transcribed and classified into a player observation. Preview.

Games

Finalize a game to derive its stats and game events from the notes captured during it. Preview.

Parsing helpers

Turn free text into a structured game, practice, calendar event, or in-game event — without persisting anything. Preview.

Retrieval & webhooks

Read your data back out and subscribe to changes. Roadmap.

Video & alignment

Ingest raw or pre-tagged video — streamed or synced after the fact — aligned to the game timeline. Roadmap.

Availability labels

Nothing here is commercially available yet. Every endpoint and capability carries one of two labels — read them literally.
Preview — grounded in a capability that already powers the RinkNotes app. The shapes shown are real, but the endpoint isn’t commercially available yet; access is provisioned with you as we roll out the API.
Roadmap — not built as a partner capability yet. Any shapes shown are illustrative, not a contract.

Authentication

The RinkNotes app authenticates today with a Supabase user JWT, sent as a bearer token:
Anonymous tokens are rejected, and access to a team’s data is gated by team membership. This is how the app works internally — it’s not an external developer credential. Internal processing jobs (classification, stat and event derivation, weekly synthesis) run on a service role that is never client-accessible. You’d never call those directly — they’re triggered by the endpoints that own them.
Preview. When we open the API, external clients will authenticate with a per-organization API key — issued and scoped to your org during onboarding — rather than a user’s JWT. There’s no self-serve key issuance yet; we’d provision it with you. Tell us what scoping and rotation you’d expect.

Base URL & conventions

When the API opens, endpoints will be reached under a single stable gateway that fronts the RinkNotes functions host:
This gateway isn’t commercially available yet — the path and payloads on the planned endpoints page reflect the real internal shapes so you can react to them, not a live public endpoint.
  • All endpoints are POST.
  • Bodies are JSON (Content-Type: application/json), except audio ingest, which is multipart/form-data.
  • Responses are JSON.
  • Errors use standard HTTP status codes: 400 (bad request), 401 (missing/invalid auth), 403 (not permitted for this team), 404 (not found), 429 (rate limited), 502 (an upstream dependency failed).

See the planned endpoints

Real paths, payloads, and responses — grounded in the live product, previewed for partners.

Tell us what you’d build

This surface is still taking shape. If there’s an endpoint, a data shape, or an integration pattern you’d want, we want to hear it before we finalize the design.

Share your use case

Tell us what you’d integrate and how your data is shaped — we’ll factor it in.