# Schema

## threads

type: integer

notes: Number of threads to utilize.

{% hint style="info" %}
Setting to -1 will use all available threads
{% endhint %}

## anon\_metrics\_enable

type: bool

notes: If enabled, allows anonymous metrics. This allows capture of which run types and settings are used to understand app usage

## deemix

### arl

**type:** string

**notes:** Cookie[ ](https://pastebin.com/Wn7TaZFB)required for Deezer download functionality. 

{% hint style="info" %}
See [Getting a Deezer arl](/guides/getting-a-deezer-arl.md)
{% endhint %}

### download\_path

**type:** string

**notes:** Path that spotify\_sync will download songs into.

### max\_bitrate

**type:** string

**oneOf:** '128', '320', 'lossless'

**notes:** The highest download quality to attempt. '320' & 'lossless' require a Deezer Hi-Fi account.

### skip\_low\_quality

**type:** boolean

**notes:** If true and max\_bitrate > '128', check that the Deezer account has privileges to stream the requested quality. If not, exit before downloads commence.

{% hint style="info" %}
This is especially useful if you rotate Deezer Hi-Fi free trials and don't want to accidentally download 128kbps once your trial has ended.
{% endhint %}

### strict\_matching

**type:** boolean

**notes:** If true, only successfully match a Spotify song to Deezer via it's ISRC. Setting to false allows fallback to Title - Artist - Album search.

## spotify

### username

**type:** string

**notes:** Your Spotify account username.

{% hint style="info" %}
This can be found in your [account overview](https://www.spotify.com/us/account/overview/), it is important it is set correctly
{% endhint %}

### custom\_application/enabled

**type:** boolean

**notes:** Whether to use your own Spotify OAuth2 application instead

{% hint style="info" %}
OAuth2 is currently implemented via PCKE and access tokens stay on your device. However if you'd like to create and use you're own OAuth application you can
{% endhint %}

### **custom\_application/client\_id**

**type:** string

**notes:** Client id of Spotify application.

{% hint style="info" %}
See [Setting up a Spotify oauth application](/guides/setting-up-a-spotify-oauth-application.md)
{% endhint %}

### **custom\_application/**client\_secret

**type:** string

**notes:** Client secret of Spotify application.

{% hint style="info" %}
See [Setting up a Spotify oauth application](/guides/setting-up-a-spotify-oauth-application.md)
{% endhint %}

### **custom\_application/**scope

**type:** string

**notes:** The scope to use when authenticating to your Spotify account. If unsure, leave as default.

### **custom\_application/**redirect\_uri\_port

**type:** string

**notes:** Any usable host port, must match what application has been setup with. If unsure, leave as default.

### playlists/enabled

**type:** boolean

**notes:** Include playlist songs in download

{% hint style="info" %}
Songs in playlists that are already 'liked' :green\_heart: will be downloaded without enabling this feature. Use if you want to include playlist songs that aren't liked
{% endhint %}

### playlists/owner\_only

**type:** boolean

**notes:** Only download playlists you've created yourself, not followed.

### playlists/excluded

**type:** array of strings

**notes:** A list of playlists you wish to be excluded from download (case sensitive).

{% hint style="info" %}
To view all playlists associated with your account run: 

spotify\_sync stats playlists
{% endhint %}

## pushover

### enabled

**type:** boolean

**notes:** Enable [Pushover ](https://pushover.net/)notifications for run modes.

### user\_key

**type:** string

**notes:** Pushover user key.

### api\_token

**type:** string

**notes:** Pushover token (per Pushover application).

## autoscan

### enabled

**type:** boolean

**notes:** Enable [autoscan ](https://github.com/Cloudbox/autoscan)integration. Assumes you have set this up correctly and created rewrite rules if needed.

### endpoint

**type:** string

**notes:** The API endpoint to POST to.

### auth\_enabled

**type:** boolean

**notes:** Enable basic auth

### username

**type:** string

**notes:** Basic auth username

### password

**type:** string

**notes:** Basic auth password

##

##


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.spotify-sync.jbh.cloud/configuration/schema.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.