API overview
What the Soundwaves GraphQL API is, where it lives and how to make your first request.
Everything in Studio runs on the same GraphQL API that you can use yourself: shows, episodes, presenters, the schedule, song requests, music scheduling and more.
Endpoints
| URL | |
|---|---|
| GraphQL over HTTP | https://api.staging.swztech.net/graphql |
Subscriptions (WebSocket, graphql-ws) | wss://api.staging.swztech.net/graphql/ws |
Requests are POST with a JSON body of query, variables and, optionally, operationName.
Your first request
Public fields need no sign-in. This asks the API whether it’s healthy:
curl https://api.staging.swztech.net/graphql \
-H "Content-Type: application/json" \
-d '{ "query": "{ healthcheck { __typename } }" }'To read or change your own organisation’s data, send a credential. See Authentication.
What you’ll find in the reference
The GraphQL reference is generated from the API’s schema every time these docs are built, so it always matches what’s deployed. Each field shows who can use it:
- Public fields work without signing in, for a site’s listener-facing data.
- Permission notes list the role permissions a signed-in user or key needs, such as
shows:write. - Add-on notes mark fields that need a paid add-on, such as music scheduling.
Operation pages include a playground, so you can run a query straight from the page.
The reference covers the public API only. Internal service, platform and Relay protocol fields are left out, as are features that are still in early access.