Spotify auth provider

At this time, Arcade does not offer a default Spotify Auth Provider. To use Spotify auth, you must create a custom Auth Provider with your own Spotify OAuth 2.0 credentials.

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

How you configure the Spotify auth provider depends on whether you use the Arcade Cloud Engine or a self-hosted Engine.

When you are ready to go to production, you’ll want to configure the Spotify auth provider with your own Spotify app credentials, so users see your app name when they authorize access.

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

Configuring Spotify auth with the Arcade Dashboard

Navigate to the OAuth section of the Arcade Dashboard and click Add OAuth Provider.
Select Spotify as the provider.
Choose a unique ID for your provider (e.g. “my-spotify-provider”) with an optional Description.
Enter your Client ID and Client Secret from your Spotify app.
Click Save.

When you use tools that require Spotify auth using your Arcade account credentials, the Arcade Engine will automatically use this Spotify OAuth provider.

Configuring Spotify auth in self-hosted Arcade Engine configuration

Set environment variables

Set the following environment variables:

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

Or, you can set these values in a .env file:

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

See Engine configuration for more information on how to set environment variables and configure the Arcade Engine.

Edit the Engine configuration

Edit the engine.yaml file and add a spotify item to the auth.providers section:

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 = "[email protected]"
 
# 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...

Using Spotify auth in custom tools

The Arcade Model API is a convenient way to call language models and automatically invoke 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()

Slack X