spotify.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.
Albums
get
albums.get
Get info about an album
Risk: read
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
market | string | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
name | string | Yes | — |
album_type | string | Yes | — |
total_tracks | number | No | — |
available_markets | string[] | No | — |
external_urls | object | No | — |
href | string | No | — |
images | object[] | No | — |
release_date | string | No | — |
release_date_precision | string | No | — |
artists | object[] | No | — |
external_urls full type
external_urls full type
images full type
images full type
artists full type
artists full type
getNewReleases
albums.getNewReleases
Get new album releases
Risk: read
| Name | Type | Required | Description |
|---|---|---|---|
limit | number | No | — |
offset | number | No | — |
country | string | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
albums | object | Yes | — |
albums full type
albums full type
getTracks
albums.getTracks
Get tracks from an album
Risk: read
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
limit | number | No | — |
offset | number | No | — |
market | string | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
href | string | No | — |
limit | number | No | — |
next | string | No | — |
offset | number | No | — |
previous | string | No | — |
total | number | No | — |
items | object[] | No | — |
items full type
items full type
search
albums.search
Search for albums
Risk: read
| Name | Type | Required | Description |
|---|---|---|---|
q | string | Yes | — |
type | album | No | — |
market | string | No | — |
limit | number | No | — |
offset | number | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
albums | object | Yes | — |
albums full type
albums full type
Artists
get
artists.get
Get info about an artist
Risk: read
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
name | string | Yes | — |
external_urls | object | No | — |
followers | object | No | — |
genres | string[] | No | — |
href | string | No | — |
images | object[] | No | — |
popularity | number | No | — |
external_urls full type
external_urls full type
followers full type
followers full type
images full type
images full type
getAlbums
artists.getAlbums
Get albums by an artist
Risk: read
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
include_groups | string | No | — |
market | string | No | — |
limit | number | No | — |
offset | number | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
href | string | No | — |
limit | number | No | — |
next | string | No | — |
offset | number | No | — |
previous | string | No | — |
total | number | No | — |
items | object[] | No | — |
items full type
items full type
getRelatedArtists
artists.getRelatedArtists
Get artists related to an artist
Risk: read
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
artists | object[] | No | — |
artists full type
artists full type
getTopTracks
artists.getTopTracks
Get top tracks for an artist
Risk: read
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
market | string | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
tracks | object[] | No | — |
tracks full type
tracks full type
search
artists.search
Search for artists
Risk: read
| Name | Type | Required | Description |
|---|---|---|---|
q | string | Yes | — |
type | artist | No | — |
market | string | No | — |
limit | number | No | — |
offset | number | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
artists | object | Yes | — |
artists full type
artists full type
Library
getLikedTracks
library.getLikedTracks
Get the current user’s liked tracks
Risk: read
| Name | Type | Required | Description |
|---|---|---|---|
limit | number | No | — |
offset | number | No | — |
market | string | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
href | string | No | — |
limit | number | No | — |
next | string | No | — |
offset | number | No | — |
previous | string | No | — |
total | number | No | — |
items | object[] | No | — |
items full type
items full type
My Data
getFollowedArtists
myData.getFollowedArtists
Get artists followed by the current user
Risk: read
| Name | Type | Required | Description |
|---|---|---|---|
type | artist | No | — |
limit | number | No | — |
after | string | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
artists | object | Yes | — |
artists full type
artists full type
Player
addToQueue
player.addToQueue
Add a track to the playback queue
Risk: write
| Name | Type | Required | Description |
|---|---|---|---|
uri | string | Yes | — |
device_id | string | No | — |
getCurrentlyPlaying
player.getCurrentlyPlaying
Get the currently playing track
Risk: read
| Name | Type | Required | Description |
|---|---|---|---|
market | string | No | — |
additional_types | string | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
timestamp | number | No | — |
context | object | No | — |
progress_ms | number | No | — |
is_playing | boolean | No | — |
item | object | No | — |
currently_playing_type | string | No | — |
actions | object | No | — |
context full type
context full type
item full type
item full type
actions full type
actions full type
getRecentlyPlayed
player.getRecentlyPlayed
Get recently played tracks
Risk: read
| Name | Type | Required | Description |
|---|---|---|---|
limit | number | No | — |
after | number | No | — |
before | number | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
items | object[] | No | — |
next | string | No | — |
cursors | object | No | — |
limit | number | No | — |
items full type
items full type
cursors full type
cursors full type
pause
player.pause
Pause playback
Risk: write
| Name | Type | Required | Description |
|---|---|---|---|
device_id | string | No | — |
resume
player.resume
Resume playback
Risk: write
| Name | Type | Required | Description |
|---|---|---|---|
device_id | string | No | — |
setVolume
player.setVolume
Set the playback volume
Risk: write
| Name | Type | Required | Description |
|---|---|---|---|
volume_percent | number | Yes | — |
device_id | string | No | — |
skipToNext
player.skipToNext
Skip to the next track
Risk: write
| Name | Type | Required | Description |
|---|---|---|---|
device_id | string | No | — |
skipToPrevious
player.skipToPrevious
Skip to the previous track
Risk: write
| Name | Type | Required | Description |
|---|---|---|---|
device_id | string | No | — |
startPlayback
player.startPlayback
Start playback of specified content
Risk: write
| Name | Type | Required | Description |
|---|---|---|---|
device_id | string | No | — |
context_uri | string | No | — |
uris | string[] | No | — |
offset | object | No | — |
position_ms | number | No | — |
offset full type
offset full type
Playlists
addItem
playlists.addItem
Add a track to a playlist
Risk: write
| Name | Type | Required | Description |
|---|---|---|---|
playlist_id | string | Yes | — |
uris | string[] | Yes | — |
position | number | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
snapshot_id | string | No | — |
create
playlists.create
Create a new playlist
Risk: write
| Name | Type | Required | Description |
|---|---|---|---|
user_id | string | Yes | — |
name | string | Yes | — |
public | boolean | No | — |
collaborative | boolean | No | — |
description | string | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
name | string | Yes | — |
description | string | No | — |
public | boolean | No | — |
collaborative | boolean | No | — |
owner | object | No | — |
followers | object | No | — |
images | object[] | No | — |
tracks | object | No | — |
external_urls | object | No | — |
href | string | No | — |
owner full type
owner full type
followers full type
followers full type
images full type
images full type
tracks full type
tracks full type
external_urls full type
external_urls full type
get
playlists.get
Get info about a playlist
Risk: read
| Name | Type | Required | Description |
|---|---|---|---|
playlist_id | string | Yes | — |
market | string | No | — |
fields | string | No | — |
additional_types | string | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
name | string | Yes | — |
description | string | No | — |
public | boolean | No | — |
collaborative | boolean | No | — |
owner | object | No | — |
followers | object | No | — |
images | object[] | No | — |
tracks | object | No | — |
external_urls | object | No | — |
href | string | No | — |
owner full type
owner full type
followers full type
followers full type
images full type
images full type
tracks full type
tracks full type
external_urls full type
external_urls full type
getTracks
playlists.getTracks
Get tracks in a playlist
Risk: read
| Name | Type | Required | Description |
|---|---|---|---|
playlist_id | string | Yes | — |
market | string | No | — |
fields | string | No | — |
limit | number | No | — |
offset | number | No | — |
additional_types | string | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
href | string | No | — |
limit | number | No | — |
next | string | No | — |
offset | number | No | — |
previous | string | No | — |
total | number | No | — |
items | object[] | No | — |
items full type
items full type
getUserPlaylists
playlists.getUserPlaylists
Get the current user’s playlists
Risk: read
| Name | Type | Required | Description |
|---|---|---|---|
user_id | string | No | — |
limit | number | No | — |
offset | number | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
href | string | No | — |
limit | number | No | — |
next | string | No | — |
offset | number | No | — |
previous | string | No | — |
total | number | No | — |
items | object[] | No | — |
items full type
items full type
removeItem
playlists.removeItem
Remove a track from a playlist
Risk: write
| Name | Type | Required | Description |
|---|---|---|---|
playlist_id | string | Yes | — |
tracks | object[] | Yes | — |
snapshot_id | string | No | — |
tracks full type
tracks full type
| Name | Type | Required | Description |
|---|---|---|---|
snapshot_id | string | No | — |
search
playlists.search
Search for playlists
Risk: read
| Name | Type | Required | Description |
|---|---|---|---|
q | string | Yes | — |
type | playlist | No | — |
market | string | No | — |
limit | number | No | — |
offset | number | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
playlists | object | Yes | — |
playlists full type
playlists full type
Tracks
get
tracks.get
Get info about a track
Risk: read
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
market | string | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
name | string | Yes | — |
artists | object[] | No | — |
album | object | No | — |
duration_ms | number | No | — |
explicit | boolean | No | — |
external_urls | object | No | — |
href | string | No | — |
is_local | boolean | No | — |
popularity | number | No | — |
preview_url | string | No | — |
track_number | number | No | — |
artists full type
artists full type
album full type
album full type
external_urls full type
external_urls full type
getAudioFeatures
tracks.getAudioFeatures
Get audio features for a track
Risk: read
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
danceability | number | No | — |
energy | number | No | — |
key | number | No | — |
loudness | number | No | — |
mode | number | No | — |
speechiness | number | No | — |
acousticness | number | No | — |
instrumentalness | number | No | — |
liveness | number | No | — |
valence | number | No | — |
tempo | number | No | — |
duration_ms | number | No | — |
time_signature | number | No | — |
search
tracks.search
Search for tracks
Risk: read
| Name | Type | Required | Description |
|---|---|---|---|
q | string | Yes | — |
type | track | No | — |
market | string | No | — |
limit | number | No | — |
offset | number | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
tracks | object | Yes | — |
tracks full type
tracks full type