Spotify logo

Spotify

Spotify is a digital music and podcast streaming service with millions of tracks, personalized playlists, and social sharing features

84 actions Integration catalog
Request access
Connect Spotify once you're in Boring.
01 · WHAT THE AGENT CAN DO

Actions

Every capability is a discrete, logged action the agent calls by name — scoped to what you authorize and recorded in the run trace.

Add items to playlistSPOTIFY_ADD_ITEMS_TO_PLAYLIST
Add one or more items to a user's playlist.
Add item to playback queueSPOTIFY_ADD_ITEM_TO_PLAYBACK_QUEUE
Add an item to the end of the user's current playback queue. This API only works for users who have Spotify Premium. The order of execution is not guaranteed when you use this API with other Player API endpoints. Required scope: user-modify-playback-state Note: Only tracks and episodes can be added to the queue. Albums and playlists cannot be added directly.
Change playlist detailsSPOTIFY_CHANGE_PLAYLIST_DETAILS
Change a playlist's name and public/private state. The user must own the playlist. This action allows updating the playlist name, description, public/private status, and collaborative mode. At least one of the optional parameters (name, public, collaborative, description) must be provided. Important constraints: - collaborative can only be set to true on non-public playlists (when public is false) - Requires OAuth scope: playlist-modify-public (for public playlists) or playlist-modify-private (for private playlists) - The playlist must be owned by the authenticated user
Check if user follows artists or usersSPOTIFY_CHECK_IF_USER_FOLLOWS_ARTISTS_OR_USERS
Check to see if the current user is following one or more artists or other Spotify users.
Check if users follow playlistSPOTIFY_CHECK_IF_USERS_FOLLOW_PLAYLIST
Check if the current authenticated user is following a specified playlist. This endpoint checks whether the authenticated user follows the given playlist. It returns a boolean value indicating whether the user follows the playlist. Important: Despite the parameter being named 'ids', this endpoint only works for checking if the current authenticated user follows a playlist. You cannot check if arbitrary users follow a playlist. Note: The playlist must be public or the requesting user must own the playlist.
Check user s saved albumsSPOTIFY_CHECK_USER_S_SAVED_ALBUMS
Check if one or more albums is already saved in the current Spotify user's 'Your Music' library.
Check user s saved audiobooksSPOTIFY_CHECK_USER_S_SAVED_AUDIOBOOKS
Check if one or more audiobooks are already saved in the current Spotify user's library. Returns an array of boolean values indicating whether each audiobook (by ID) is saved in the user's library. Requires user-library-read scope.
Check User's Saved EpisodesSPOTIFY_CHECK_USER_S_SAVED_EPISODES
Check if one or more podcast episodes are saved in the current Spotify user's 'Your Episodes' library. Returns an array of boolean values corresponding to each episode ID provided. **Required OAuth Scope:** user-library-read **Note:** This endpoint is currently in beta and may change without notice.
Check user's saved showsSPOTIFY_CHECK_USER_S_SAVED_SHOWS
Check if one or more shows is already saved in the current Spotify user's library. This endpoint checks whether the specified shows are saved in the authenticated user's library. It returns a list of boolean values, one for each show ID provided, indicating whether that show is saved.
Check User's Saved TracksSPOTIFY_CHECK_USER_S_SAVED_TRACKS
Check if one or more tracks is already saved in the current Spotify user's 'Your Music' library. Returns an array of boolean values indicating whether each track is saved (true) or not (false), in the same order as the requested IDs.
Create playlistSPOTIFY_CREATE_PLAYLIST
Create a playlist for a Spotify user. (The playlist will be empty until you [add tracks](/documentation/web-api/reference/add-tracks-to-playlist).) Each user is generally limited to a maximum of 11000 playlists.
Follow artists or usersSPOTIFY_FOLLOW_ARTISTS_OR_USERS
Follow one or more artists or Spotify users on behalf of the current authenticated user. This action adds the specified artists or users to the current user's "Following" list, making their content appear in the user's personalized feed. The operation is idempotent - attempting to follow an already-followed artist/user will succeed without error. Required OAuth scope: user-follow-modify Common use cases: - Follow an artist after liking their music - Follow multiple artists at once (up to 50) - Follow other Spotify users to see their public playlists and activity Note: Artist IDs can be obtained from search results, track objects, or album objects. User IDs can be obtained from user profile endpoints or playlist owner information.
Follow playlistSPOTIFY_FOLLOW_PLAYLIST
Add the current user as a follower of a playlist. This action adds the current user as a follower of a specified playlist. The 'public' parameter controls whether the playlist will appear in the user's public profile (visible to others) or remain private (only visible to the user). This operation is idempotent - if the user is already following the playlist, the operation will still succeed without error. Required OAuth scopes: - playlist-modify-public: For following playlists publicly - playlist-modify-private: For following playlists privately Note: Following a playlist does not make you its owner. You can follow any playlist (public, private, or collaborative) if you know its Spotify ID.
Get a chapterSPOTIFY_GET_A_CHAPTER
Get Spotify catalog information for a single audiobook chapter including name, description, duration, release date, narrators, and playback information. Audiobook chapters are only available within the US, UK, Canada, Ireland, New Zealand and Australia markets. Use this action to retrieve detailed metadata about a specific chapter when you have its Spotify ID.
Get Album DetailsSPOTIFY_GET_ALBUM
Get Spotify catalog information for a single album. Returns comprehensive album data including metadata, track listing, artist information, cover artwork, popularity score, and availability by market. Use this to fetch details about any album in Spotify's catalog using its unique album ID.
Get album tracksSPOTIFY_GET_ALBUM_TRACKS
Get Spotify catalog information about an album's tracks. Optional parameters can be used to limit the number of tracks returned.
Get an audiobookSPOTIFY_GET_AN_AUDIOBOOK
Get Spotify catalog information for a single audiobook. Audiobooks are only available within the US, UK, Canada, Ireland, New Zealand and Australia markets.
Get artistSPOTIFY_GET_ARTIST
Get detailed Spotify catalog information for a single artist. Returns comprehensive artist data including the artist's name, genres, follower count, profile images, popularity score (0-100), and links to their Spotify profile. Use this action to retrieve metadata about any artist in the Spotify catalog.
Get artist s albumsSPOTIFY_GET_ARTIST_S_ALBUMS
Get Spotify catalog information about an artist's albums.
Get artist s related artistsSPOTIFY_GET_ARTIST_S_RELATED_ARTISTS
Get Spotify catalog information about artists similar to a given artist. Similarity is based on analysis of the Spotify community's listening history.
Get Artist's Top TracksSPOTIFY_GET_ARTIST_S_TOP_TRACKS
Get Spotify catalog information about an artist's top tracks by country/market. Returns up to 10 of the artist's most popular tracks in the specified market. Each track includes detailed metadata such as album information, duration, popularity score (0-100), explicit content flag, and preview URLs. Use cases: - Display an artist's most popular songs in a specific region - Build artist profile pages with top tracks - Recommend popular content from an artist to users Note: Track popularity varies by market. The same artist may have different top tracks in different countries based on regional streaming patterns.
Get audiobook chaptersSPOTIFY_GET_AUDIOBOOK_CHAPTERS
Get Spotify catalog information about an audiobook's chapters. Audiobooks are only available within the US, UK, Canada, Ireland, New Zealand and Australia markets.
Get Available DevicesSPOTIFY_GET_AVAILABLE_DEVICES
Get information about the user's available Spotify Connect devices. Returns a list of devices that can be used for playback, including their names, types (computer, smartphone, speaker), active status, volume levels, and whether they support API control. Useful for checking available playback targets before transferring playback or controlling volume. Requires the 'user-read-playback-state' scope. Note: Some device models are not supported and will not be listed in the API response.
Get available genre seedsSPOTIFY_GET_AVAILABLE_GENRE_SEEDS
Get available genre seeds for Spotify recommendations. Returns a list of genre strings that can be used as seed_genres parameter when requesting music recommendations. These genres represent the full set of available genre seeds on Spotify. No parameters are required for this endpoint. Note: This endpoint is deprecated but still functional as of the current API version.
Get available marketsSPOTIFY_GET_AVAILABLE_MARKETS
Get the list of markets where Spotify is available. Returns an array of ISO 3166-1 alpha-2 country codes.
Get Category's PlaylistsSPOTIFY_GET_CATEGORY_S_PLAYLISTS
Get Spotify playlists tagged with a specific category (e.g., 'workout', 'party', 'dinner'). Returns a paginated list of playlists for the specified category. Use the limit and offset parameters to control pagination. Category IDs can be obtained from the Get Several Browse Categories endpoint. NOTE: This endpoint is deprecated as of November 2024 and may return 403 Forbidden for apps without extended quota access that was approved before November 27, 2024. Consider alternative endpoints for new implementations.
Get currently playing trackSPOTIFY_GET_CURRENTLY_PLAYING_TRACK
Get the object currently being played on the user's Spotify account.
Get current user s playlistsSPOTIFY_GET_CURRENT_USER_S_PLAYLISTS
Get a list of the playlists owned or followed by the current Spotify user. Returns a paginated list of playlists (both public and private) that the current user owns or follows. Each playlist includes basic metadata such as name, description, owner information, track count, images, and collaborative/public status. Use the limit and offset parameters to paginate through results. The response includes pagination links (next/previous) for easier navigation through large result sets.
Get current user s profileSPOTIFY_GET_CURRENT_USER_S_PROFILE
Get detailed profile information about the current authenticated user. This endpoint returns comprehensive user profile data including display name, email address, country, subscription level (premium/free), explicit content settings, profile images, follower count, and Spotify URIs. Required OAuth scopes: - user-read-private: Required to access country, product (subscription level), and explicit content settings - user-read-email: Required to access the user's email address Returns a private user object with all available profile information for the authenticated user.
Get episodeSPOTIFY_GET_EPISODE
Get Spotify catalog information for a single podcast episode identified by its unique Spotify ID. This endpoint retrieves detailed information about a podcast episode including its name, description, duration, release date, cover art, show information, and playback status. It can also return the user's resume point if the user-read-playback-position scope is authorized. Episodes are podcast content on Spotify. Use this endpoint to get metadata and playback information for a specific episode when you have its Spotify ID.
Get featured playlistsSPOTIFY_GET_FEATURED_PLAYLISTS
Get a list of Spotify's editorially curated featured playlists. These are the playlists shown on a Spotify player's 'Browse' tab and are updated regularly by Spotify's editorial team. The response includes a localized message and a paginated list of simplified playlist objects.
Get followed artistsSPOTIFY_GET_FOLLOWED_ARTISTS
Get all artists followed by the current user. Returns a cursor-paginated list of artist objects with full details including name, genres, popularity, images, and follower counts. Use the 'after' parameter to navigate through pages of results. Requires the 'user-follow-read' authorization scope.
Get new releasesSPOTIFY_GET_NEW_RELEASES
Get a list of new album releases featured in Spotify (shown, for example, on a Spotify player's "Browse" tab).
Get playback stateSPOTIFY_GET_PLAYBACK_STATE
Get information about the user's current playback state, including track or episode, progress, and active device. Returns detailed playback information when content is actively playing, including the current track/episode, playback progress, device details, repeat/shuffle state, and playback context. Returns HTTP 204 (No Content) when nothing is currently playing. Requires OAuth scope: user-read-playback-state
Get playlistSPOTIFY_GET_PLAYLIST
Get a playlist owned by a Spotify user. This endpoint retrieves detailed information about a specific Spotify playlist, including its metadata (name, description, public/collaborative status), owner information, cover images, and the tracks/episodes it contains. The response includes a paginated tracks object with full details about each item in the playlist. Required OAuth scope: playlist-read-private (for private playlists) or playlist-read-collaborative (for collaborative playlists). Public playlists can be accessed without special scopes.
Get playlist cover imageSPOTIFY_GET_PLAYLIST_COVER_IMAGE
Get the current image(s) associated with a specific playlist. Returns an array of image objects containing the URL, height, and width of each cover image. The array may be empty if the playlist has no cover image, or contain up to three images returned by size in descending order. Note: The source URL for the image is temporary and will expire in less than a day.
Get playlist itemsSPOTIFY_GET_PLAYLIST_ITEMS
Get full details of the items of a playlist owned by a Spotify user. This endpoint retrieves the tracks and/or episodes in a playlist. It supports pagination and allows filtering the response fields for optimization.
Get recently played tracksSPOTIFY_GET_RECENTLY_PLAYED_TRACKS
Get tracks from the current user's recently played tracks. _**Note**: Currently doesn't support podcast episodes._
Get recommendationsSPOTIFY_GET_RECOMMENDATIONS
Get track recommendations based on seed artists, genres, and/or tracks. At least one seed is required (up to 5 total). Optionally tune recommendations with audio feature parameters (acousticness, danceability, energy, etc.). IMPORTANT: This endpoint requires Spotify Extended API Access (restricted since Nov 27, 2024). Accounts without extended access will receive a 404 error. See: https://developer.spotify.com/blog/2024-11-27-changes-to-the-web-api Returns a list of recommended tracks with full track metadata including artists, album info, and audio features.
Get several albumsSPOTIFY_GET_SEVERAL_ALBUMS
Get Spotify catalog information for multiple albums identified by their Spotify IDs. Returns detailed album data including name, artists, tracks, release date, images, and more. Maximum 20 album IDs per request.
Get several artistsSPOTIFY_GET_SEVERAL_ARTISTS
Get Spotify catalog information for several artists based on their Spotify IDs.
Get several audiobooksSPOTIFY_GET_SEVERAL_AUDIOBOOKS
Retrieve Spotify catalog information for multiple audiobooks in a single request. This action fetches detailed metadata for up to 50 audiobooks at once using their Spotify IDs. Each audiobook object includes: - Title, description, and edition information - Authors and narrators - Chapter information and count - Cover images in multiple sizes - Language and market availability - Publisher and copyright details Audiobooks that don't exist or are unavailable in the requested market will appear as null in the response array (not omitted). **Important**: Audiobooks are only available in US, UK, Canada, Ireland, New Zealand, and Australia markets. Specify the market parameter to ensure content availability for your target region. **Use Cases**: - Bulk retrieval of audiobook metadata - Validating audiobook availability across markets - Building audiobook catalogs or collections - Displaying audiobook details in applications
Get several browse categoriesSPOTIFY_GET_SEVERAL_BROWSE_CATEGORIES
Get a list of categories used to tag items in Spotify (on, for example, the Spotify player's "Browse" tab).
Get several chaptersSPOTIFY_GET_SEVERAL_CHAPTERS
Get Spotify catalog information for several audiobook chapters identified by their Spotify IDs. This endpoint allows you to fetch detailed information about up to 50 chapters at once, including chapter metadata, duration, descriptions, images, and parent audiobook information. Chapters are only available within the US, UK, Canada, Ireland, New Zealand and Australia markets.
Get several episodesSPOTIFY_GET_SEVERAL_EPISODES
Get Spotify catalog information for several episodes based on their Spotify IDs.
Get several showsSPOTIFY_GET_SEVERAL_SHOWS
Get Spotify catalog information for several shows (podcasts) based on their Spotify IDs. This endpoint allows you to retrieve detailed information about multiple shows in a single request, with a maximum of 50 show IDs per request.
Get several tracksSPOTIFY_GET_SEVERAL_TRACKS
Get Spotify catalog information for multiple tracks based on their Spotify IDs.
Get several tracks audio featuresSPOTIFY_GET_SEVERAL_TRACKS_AUDIO_FEATURES
Get audio features for multiple tracks based on their Spotify IDs. Returns audio feature information for multiple tracks including danceability, energy, loudness, speechiness, acousticness, instrumentalness, liveness, valence, tempo, and other musical attributes. Note: This endpoint was deprecated by Spotify on November 27, 2024. Applications created or approved after this date will receive 403 Forbidden errors. Only applications with existing extended mode Web API access that were relying on this endpoint before the cutoff date remain unaffected.
Get showSPOTIFY_GET_SHOW
Get Spotify catalog information for a single show (podcast) identified by its unique Spotify ID.
Get show episodesSPOTIFY_GET_SHOW_EPISODES
Get Spotify catalog information about a show's episodes. Optional parameters can be used to limit the number of episodes returned. This endpoint retrieves a paginated list of episodes for a specific podcast/show.
Get single browse categorySPOTIFY_GET_SINGLE_BROWSE_CATEGORY
Get a single category used to tag items in Spotify (on, for example, the Spotify player's "Browse" tab). Returns detailed information about the category including its name, icons, and unique identifier.
Get the user's queueSPOTIFY_GET_THE_USER_S_QUEUE
Get the list of tracks and episodes in the user's playback queue. Returns the currently playing track/episode and the queue of upcoming items. This is a read-only operation that does not modify the queue. Requirements: - Spotify Premium subscription required - Requires one of these OAuth scopes: - user-read-currently-playing - user-read-playback-state - An active Spotify session (user must be logged in on a device) Returns: - currently_playing: The track or episode currently playing (may be null) - queue: List of tracks/episodes queued for playback (may be empty) Common errors: - 403 Forbidden: Premium subscription required or insufficient OAuth scopes - 204 No Content: No active playback session
Get trackSPOTIFY_GET_TRACK
Get Spotify catalog information for a single track identified by its unique Spotify ID.
Get Track's Audio AnalysisSPOTIFY_GET_TRACK_S_AUDIO_ANALYSIS
Get a comprehensive audio analysis for a Spotify track. Returns detailed structural and musical characteristics including: - Meta information (analyzer version, timestamp, processing time) - Track properties (tempo, key, mode, time signature, loudness, duration) - Temporal structure (bars, beats, sections, tatums) - Segments with pitch content and timbre characteristics All timing values are in seconds. Confidence scores range from 0.0 to 1.0. Useful for music analysis, visualization, and recommendation systems.
Get track's audio featuresSPOTIFY_GET_TRACK_S_AUDIO_FEATURES
Get audio feature information for a single track identified by its unique Spotify ID. Note: This endpoint was deprecated by Spotify on November 27, 2024. Applications created or approved after this date will receive 403 Forbidden errors. Only applications with existing extended mode Web API access that were relying on this endpoint before the cutoff date remain unaffected.
Get user's playlistsSPOTIFY_GET_USER_S_PLAYLISTS
Get a paginated list of playlists owned or followed by a Spotify user. This endpoint retrieves all public playlists for any user. To access private and collaborative playlists, you must have the appropriate OAuth scopes and the user must have authorized your application. Required OAuth scopes for private/collaborative playlists: - playlist-read-private: Required to access user's private playlists - playlist-read-collaborative: Required to access collaborative playlists The response includes playlist metadata such as name, description, owner info, images, track count, and collaboration status. Use the limit and offset parameters to paginate through large playlist collections. Common use cases: - Display a user's public playlist library - Build playlist discovery features - Analyze user's music organization patterns - Enable playlist selection interfaces
Get user's profileSPOTIFY_GET_USER_S_PROFILE
Get public profile information about a Spotify user. This endpoint retrieves publicly available information for any Spotify user, including their display name, profile images, follower count, and Spotify URIs. Unlike the 'Get Current User's Profile' endpoint, this only returns public data and does not require specific OAuth scopes. Returns a public user object with the user's ID, display name (if available), external URLs, follower count, profile images, and Spotify URI.
Get user s saved albumsSPOTIFY_GET_USER_S_SAVED_ALBUMS
Get a list of albums saved in the current Spotify user's library ('Your Music'). Returns a paginated list of albums that the user has saved to their library, including when each album was added and full album details (tracks, artists, images, etc.). Supports pagination via limit and offset parameters, and can filter by market availability. Required OAuth scope: user-library-read
Get user s saved audiobooksSPOTIFY_GET_USER_S_SAVED_AUDIOBOOKS
Get a list of the audiobooks saved in the current Spotify user's 'Your Music' library.
Get user's saved episodesSPOTIFY_GET_USER_S_SAVED_EPISODES
Get a list of episodes saved in the current Spotify user's library. This endpoint retrieves a paginated list of podcast episodes that the authenticated user has saved to their Spotify library. Each item in the response includes the full episode details and the timestamp when it was added to the library. **Required OAuth Scopes:** - user-library-read: Access your saved content - user-read-playback-position: Read your position in content you have played (for resume_point) **Note:** This endpoint is currently in beta and may change without warning. Please share feedback or issues in the Spotify developer community forum.
Showing the first 60 of 84 actions.