Spotify auth provider

The Spotify auth provider enables tools and agents to call the Spotify API on behalf of a user. Behind the scenes, the Arcade Engine and the Spotify auth provider seamlessly manage Spotify OAuth 2.0 authorization for your users.

What’s documented here

This page describes how to use and configure Spotify auth with Arcade.

This auth provider is used by:

• Your app code that needs to call Spotify APIs
• Or, your custom tools that need to call Spotify APIs

Configuring Spotify auth

In a production environment, you will most likely want to use your own Spotify app credentials. This way, your users will see your application’s name requesting permission.

You can use your own Spotify credentials in both the Arcade Cloud and in a self-hosted Arcade Engine instance.

Before showing how to configure your Spotify app credentials, let’s go through the steps to create a Spotify app.

Create a Spotify app

• Follow Spotify’s guide to registering an app
• Choose the “Web API” product (at a minimum)
• Set the redirect URL to: https://cloud.arcade.dev/api/v1/oauth/callback
• Copy the client ID and client secret to use below

Next, add the Spotify app to your Arcade Engine configuration. You can do this in the Arcade Dashboard, or by editing the engine.yaml file directly (for a self-hosted instance).

Configuring your own Spotify Auth Provider in Arcade

There are two ways to configure your Spotify app credentials in Arcade:

1. From the Arcade Dashboard GUI
2. By editing the engine.yaml file directly (for a self-hosted Arcade Engine)

We show both options step-by-step below.

export SPOTIFY_CLIENT_ID="<your client ID>"
export SPOTIFY_CLIENT_SECRET="<your client secret>"

SPOTIFY_CLIENT_ID="<your client ID>"
SPOTIFY_CLIENT_SECRET="<your client secret>"

auth:
  providers:
    - id: default-spotify
      description: "The default Spotify provider"
      enabled: true
      type: oauth2
      provider_id: spotify
      client_id: ${env:SPOTIFY_CLIENT_ID}
      client_secret: ${env:SPOTIFY_CLIENT_SECRET}

Using Spotify auth in app code

Use the Spotify auth provider in your own agents and AI apps to get a user token for the Spotify API. See authorizing agents with Arcade to understand how this works.

Use client.auth.start() to get a user token for the Spotify API:

from arcadepy import Arcade
 
client = Arcade()  # Automatically finds the `ARCADE_API_KEY` env variable
 
user_id = "user@example.com"
 
# Start the authorization process
auth_response = client.auth.start(
    user_id=user_id,
    provider="spotify",
    scopes=["user-read-playback-state"],
)
 
if auth_response.status != "completed":
    print("Please complete the authorization challenge in your browser:")
    print(auth_response.url)
 
# Wait for the authorization to complete
auth_response = client.auth.wait_for_completion(auth_response)
 
token = auth_response.context.token
# Do something interesting with the token...

import { Arcade } from "@arcadeai/arcadejs";
 
const client = new Arcade(); // Automatically finds the `ARCADE_API_KEY` env variable
 
const userId = "user@example.com";
 
// Start the authorization process
let authResponse = await client.auth.start(userId, "spotify", [
  "user-read-playback-state",
]);
 
if (authResponse.status !== "completed") {
  console.log("Please complete the authorization challenge in your browser:");
  console.log(authResponse.url);
}
 
// Wait for the authorization to complete
authResponse = await client.auth.waitForCompletion(authResponse);
 
const token = authResponse.context.token;
// Do something interesting with the token...

Using Spotify auth in custom tools

You can author your own custom tools that interact with the Spotify API.

Use the Spotify() auth class to specify that a tool requires authorization with Spotify. The context.authorization.token field will be automatically populated with the user’s Spotify token:

from typing import Annotated
 
import httpx
 
from arcade.sdk import ToolContext, tool
from arcade.sdk.auth import Spotify
 
 
@tool(
    requires_auth=Spotify(
        scopes=["user-read-playback-state"],
    )
)
async def get_playback_state(
    context: ToolContext,
) -> Annotated[dict, "Information about the user's current playback state"]:
    """Get information about the user's current playback state, including track or episode, progress, and active device."""
    endpoint = "/me/player"
    headers = {"Authorization": f"Bearer {context.authorization.token}"}
 
    async with httpx.AsyncClient() as client:
        response = await client.get(
            f"https://api.spotify.com/v1/{endpoint}",
            headers=headers,
        )
        response.raise_for_status()
 
        if response.status_code == 204:
            return {"status": "Playback not available or active"}
        return response.json()