OnSong Connect API

OnSong Connect API lets developers build custom apps that read and manipulate an OnSong library—whether the library is being used on stage or stored elsewhere—through a local, REST-style service that returns JSON. The practical payoff is immediate: once an app authenticates and registers a device, it can list songs, search by query, fetch detailed metadata, and retrieve or export song content (including external files) over the network.

The walkthrough starts by turning an iPad into a Connect server from the iOS app’s Share menu. After enabling “Share your library with others,” the iPad appears in the servers list with an IP address and port. Developers then open API documentation via a browser using the server’s address and the fixed port (spelled out as 5076). From there, the core requirement becomes clear: every request must include an auth token (“off token”) that is at least 16 characters long. The token must be stored by the client application and reused for subsequent calls. Before the token works, the device must be accepted by the iPad—an initial “not currently accepting users” response flips to “accepted” after the iPad grants permission.

With authentication in place, the API behaves like a set of straightforward endpoints. A GET request to a songs endpoint returns an array of song records, including fields such as id, title, artist, favorite status, and key. Query string parameters enable filtering; for example, adding q=love returns a smaller subset of songs matching that term. The same pattern extends to books: a books endpoint lists available books, and songs can be scoped to a specific book using a book parameter (e.g., songs?book=christmas). Fetching one song’s details uses the song’s id appended to the songs URL, returning structured properties like styles, keywords, duration, and chord-related information.

The most operationally useful part is content retrieval. For songs with embedded text content, calling /content returns the actual lyric/chord text. For songs that reference an external file, the API indicates this via a file-related property; in that case, requesting /file returns an attachment (the example shows a PDF). The export workflow is also built in: requesting content in different formats (such as content.pdf, content.html, xml, or plain text) triggers server-side generation of the requested representation. The result is a developer-friendly way to integrate OnSong library data into projection tools, editors, or other stage workflows without reimplementing OnSong’s internal formats.

Overall, the Connect API is presented as a local-network bridge between OnSong’s library and custom software—fast enough for interactive use, structured enough for automation, and flexible enough to handle both embedded content and external attachments through consistent REST endpoints and query parameters.