API access

The API is for another system that needs to read what your station is doing — a website, a display in the studio, a reporting spreadsheet. It is read-only: a key can see your station, and cannot change it.

Now playing needs no key at all

The now-playing feed is public, because it is meant to be embedded:

https://your-studio-domain/np/YOUR_PUBLIC_ID.json

Your public id is on the API screen. This is the same feed the Widgets use, so if all you want is the current track on a page, use a widget and skip the rest of this article.

Create a key

One key per integration, labelled so you know what it is for. The key is shown once, at creation — copy it then. If you lose it, make another and revoke the old one; there is no way to display it again, which is the point.

Keys are read-only. There is nothing to configure and no permission to choose.

What you can read

Three endpoints, all authenticated with the X-API-Key header:

• /api/v1/schedule — what is coming up
• /api/v1/history?n=20 — what has played
• /api/v1/media — what is in the library

The API screen shows a ready-made curl line for each, with your own address filled in.

Keep access tidy

Give each integration its own key rather than sharing one. When an integration is retired, or a contractor's work finishes, revoke that key — a shared key cannot be withdrawn from one place without breaking the others.

Radio Site Maker needs none of this

If you are connecting your website, use the Website screen instead. Presenter refresh, show import, schedule handover and schedule sync are all built in, and no key is involved.