For AI agents: visit https://docs.sonos.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.

Jump to Content

Plan & Build API Reference SMAPI Tools

v1.0

Plan & Build

v1.0Plan & Build API Reference SMAPI Tools

Getting Started

How Sonos Works

Content Services

Getting started with Content Services
Components and interfaces
Supported audio content
Key requirements
SOAP requests and responses
Content on Sonos
Playback on Sonos
Synchronize your service
Security
Error handling
Test your service
- Use Self Test to Validate Your Service
Submit your service
- Partner account types

Content Service Features

Adding Content Service features
Add actions
Add authentication
Add capabilities
Add favorites
Add images
Add pagination
Add playlists
Add play/Shuffle all
Add podcasts
Add programmed radio
Add ratings
Add reporting
Add search
Encrypt content
High-definition audio badging
Play audio (Cloud queue)
Save & resume playback
Localization
Supported audio formats
Tag & filter explicit content
Troubleshooting
URL schemes

Connected Home

Connected Home
Architecture
Features
Quotas and spike arrests
Connected Home Security

Control Sonos Players

Control Sonos Players
Authorize
Discover
Control
Subscribe
Volume

Sound Experience Guidelines

Sound Experience Guidelines
Principles
Households
Groups
Playback
Volume
Hardware
Performance
Restrictions
Audio Feedback

Sonos Music API

Sonos Music API
SMAPI object types

Tools

Sample apps
- JavaScript Control API Sample App

Types

Types

Resources

Support
Terms of Service
Sonos Partners' 3P Guidelines & TOU
Media Kit

Sample apps

Current sample apps available:

The JavaScript Sample App demonstrates a Control API experience in a Web app. The documentation also goes over the structure of the code in more detail.