MusicCreativeWork Intents

Introduction

The broad category of creative works that are musical in nature, includes songs, albums, playlists, and other items. These intents let users request actions related to musical works, such as adding songs to a library, controlling playback of musical works, and looking up information about musical works.

This document provides a quick reference to the MusicCreativeWork intents and corresponding slots. For details around how these intents are specified, see Understanding the Structure of the Built-in Intent Library.

Intent Signature

Use the intent signature as the intent name in your intent schema. This example shows a schema with two MusicCreativeWork intents:

{
    "intents": [
        {
            "name": "AMAZON.StopAction<object@MusicCreativeWork>"
        }, 
        {
            "name": "AMAZON.ResumeAction<object@MusicCreativeWork>"
        }
    ]
}

For more about the components of this signature, see Understanding the Structure of the Built-in Intent Library.

To see the full JSON format for intents, see Interaction Model Schema. You can also use the developer console user interface to add the intents and then see the JSON code in the JSON Editor.

MusicCreativeWork Intents

The following table summarizes the available MusicCreativeWork intents and the set of slots that may be included. For each intent, the sections below the table show:

  • A sample utterance that would invoke the intent.
  • The JSON you include in your intent schema if you want to use the intent.

  • An example of the IntentRequest sent to your skill for the provided sample utterance, illustrating the slots that may be included. For brevity, these samples leave out the full set of properties that are normally part of a complete IntentRequest.

    Note that if your interaction model includes multiple intents with similar utterances, your results may vary from these examples.

For definitions of the slots used in these intents, see MusicCreativeWork Slots.

Intent Signature Example Utterance Possible Slots
AMAZON.AddAction<object@MusicCreativeWork,targetCollection@MusicPlaylist> "add that song to my best songs ever playlist" object.owner.name
targetCollection.owner.name
targetCollection.name
object.byArtist.name
object.type
object.name
object.performedIn.name
object.sort
targetCollection.type
AMAZON.ChooseAction<object@MusicCreativeWork,sourceCollection@MusicPlaylist> "choose beethoven from my classical music playlist" sourceCollection.type
object.select
object.byArtist.name
object.genre
object.type
sourceCollection.owner.name
sourceCollection.name
AMAZON.ChooseAction<object@MusicCreativeWork> "choose the longest song" object.type
object.sort
object.name
object.genre
object.byArtist.name
AMAZON.CreateAction<object@MusicPlaylist,content@MusicCreativeWork> "can you create a playlist for country music" content.amount
content.owner.name
content.byArtist.name
object.type
content.type
content.genre
content.inLanguage.name
AMAZON.DeleteAction<object@MusicCreativeWork,sourceCollection@MusicPlaylist> "delete this song from my party playlist" sourceCollection.type
object.select
object.byArtist.name
object.genre
object.type
sourceCollection.owner.name
sourceCollection.name
AMAZON.DeleteAction<object@MusicCreativeWork> "clear this song from the playlist" sourceCollection.type
object.type
object.genre
object.byArtist.name
sourceCollection.name
AMAZON.PlaybackAction<object@MusicCreativeWork> "turn on the music" object.owner.name
object.select
object.byArtist.name
object.genre
object.contentSource
object.composer.name
object.name
object.era
object.sort
object.type
AMAZON.RepeatAction<object@MusicCreativeWork> "repeat song" object.type
AMAZON.ResumeAction<object@MusicCreativeWork> "resume music" object.type
AMAZON.SearchAction<object@MusicCreativeWork> "can you search my cloud player for an album" object.owner.name
object.select
object.genre
object.byArtist.name
object.contentSource
object.type
object.name
object.byArtist
object.contentSource.owner.name
object.inAlbum.type
object.inLanguage.name
object.contentSource.type
object.sort
object.contentSource.name
AMAZON.SearchAction<object@MusicCreativeWork[byArtist]> "who is the artist" object.byArtist.type
AMAZON.StartAction<object@MusicCreativeWork> "start song from beginning" object.type
object.select
AMAZON.StopAction<object@MusicCreativeWork> "stop playing this album" object.type
AMAZON.SuspendAction<object@MusicCreativeWork> "pause music" object.type

AddAction<object@MusicCreativeWork,targetCollection@MusicPlaylist>

User: add that song to my best songs ever playlist

Intent Schema:

{
    "intents": [
        {
            "name": "AMAZON.AddAction<object@MusicCreativeWork,targetCollection@MusicPlaylist>"
        }
    ]
}

Request:

{
    "request": {
        "type": "IntentRequest", 
        "locale": "en-US", 
        "intent": {
            "name": "AMAZON.AddAction<object@MusicCreativeWork,targetCollection@MusicPlaylist>", 
            "slots": {
                "object.type": {
                    "name": "object.type", 
                    "value": "song"
                }, 
                "targetCollection.owner.name": {
                    "name": "targetCollection.owner.name", 
                    "value": "my"
                }, 
                "targetCollection.name": {
                    "name": "targetCollection.name", 
                    "value": "best songs ever"
                }, 
                "targetCollection.type": {
                    "name": "targetCollection.type", 
                    "value": "playlist"
                }
            }
        }
    }
}

ChooseAction<object@MusicCreativeWork,sourceCollection@MusicPlaylist>

User: choose beethoven from my classical music playlist

Intent Schema:

{
    "intents": [
        {
            "name": "AMAZON.ChooseAction<object@MusicCreativeWork,sourceCollection@MusicPlaylist>"
        }
    ]
}

Request:

{
    "request": {
        "type": "IntentRequest", 
        "locale": "en-US", 
        "intent": {
            "name": "AMAZON.ChooseAction<object@MusicCreativeWork,sourceCollection@MusicPlaylist>", 
            "slots": {
                "object.byArtist.name": {
                    "name": "object.byArtist.name", 
                    "value": "beethoven"
                }, 
                "sourceCollection.owner.name": {
                    "name": "sourceCollection.owner.name", 
                    "value": "my"
                }, 
                "sourceCollection.name": {
                    "name": "sourceCollection.name", 
                    "value": "classical music"
                }, 
                "sourceCollection.type": {
                    "name": "sourceCollection.type", 
                    "value": "playlist"
                }
            }
        }
    }
}

ChooseAction<object@MusicCreativeWork>

User: choose the longest song

Intent Schema:

{
    "intents": [
        {
            "name": "AMAZON.ChooseAction<object@MusicCreativeWork>"
        }
    ]
}

Request:

{
    "request": {
        "type": "IntentRequest", 
        "locale": "en-US", 
        "intent": {
            "name": "AMAZON.ChooseAction<object@MusicCreativeWork>", 
            "slots": {
                "object.sort": {
                    "name": "object.sort", 
                    "value": "longest"
                }, 
                "object.type": {
                    "name": "object.type", 
                    "value": "song"
                }
            }
        }
    }
}

CreateAction<object@MusicPlaylist,content@MusicCreativeWork>

User: can you create a playlist for country music

Intent Schema:

{
    "intents": [
        {
            "name": "AMAZON.CreateAction<object@MusicPlaylist,content@MusicCreativeWork>"
        }
    ]
}

Request:

{
    "request": {
        "type": "IntentRequest", 
        "locale": "en-US", 
        "intent": {
            "name": "AMAZON.CreateAction<object@MusicPlaylist,content@MusicCreativeWork>", 
            "slots": {
                "object.type": {
                    "name": "object.type", 
                    "value": "playlist"
                }, 
                "content.genre": {
                    "name": "content.genre", 
                    "value": "country"
                }, 
                "content.type": {
                    "name": "content.type", 
                    "value": "music"
                }
            }
        }
    }
}

DeleteAction<object@MusicCreativeWork,sourceCollection@MusicPlaylist>

User: delete this song from my party playlist

Intent Schema:

{
    "intents": [
        {
            "name": "AMAZON.DeleteAction<object@MusicCreativeWork,sourceCollection@MusicPlaylist>"
        }
    ]
}

Request:

{
    "request": {
        "type": "IntentRequest", 
        "locale": "en-US", 
        "intent": {
            "name": "AMAZON.DeleteAction<object@MusicCreativeWork,sourceCollection@MusicPlaylist>", 
            "slots": {
                "object.type": {
                    "name": "object.type", 
                    "value": "song"
                }, 
                "sourceCollection.owner.name": {
                    "name": "sourceCollection.owner.name", 
                    "value": "my"
                }, 
                "sourceCollection.name": {
                    "name": "sourceCollection.name", 
                    "value": "party"
                }, 
                "sourceCollection.type": {
                    "name": "sourceCollection.type", 
                    "value": "playlist"
                }
            }
        }
    }
}

DeleteAction<object@MusicCreativeWork>

User: clear this song from the playlist

Intent Schema:

{
    "intents": [
        {
            "name": "AMAZON.DeleteAction<object@MusicCreativeWork>"
        }
    ]
}

Request:

{
    "request": {
        "type": "IntentRequest", 
        "locale": "en-US", 
        "intent": {
            "name": "AMAZON.DeleteAction<object@MusicCreativeWork>", 
            "slots": {
                "object.type": {
                    "name": "object.type", 
                    "value": "song"
                }, 
                "sourceCollection.type": {
                    "name": "sourceCollection.type", 
                    "value": "playlist"
                }
            }
        }
    }
}

PlaybackAction<object@MusicCreativeWork>

User: turn on the music

Intent Schema:

{
    "intents": [
        {
            "name": "AMAZON.PlaybackAction<object@MusicCreativeWork>"
        }
    ]
}

Request:

{
    "request": {
        "type": "IntentRequest", 
        "locale": "en-US", 
        "intent": {
            "name": "AMAZON.PlaybackAction<object@MusicCreativeWork>", 
            "slots": {
                "object.name": {
                    "name": "object.name", 
                    "value": "music"
                }
            }
        }
    }
}

RepeatAction<object@MusicCreativeWork>

User: repeat song

Intent Schema:

{
    "intents": [
        {
            "name": "AMAZON.RepeatAction<object@MusicCreativeWork>"
        }
    ]
}

Request:

{
    "request": {
        "type": "IntentRequest", 
        "locale": "en-US", 
        "intent": {
            "name": "AMAZON.RepeatAction<object@MusicCreativeWork>", 
            "slots": {
                "object.type": {
                    "name": "object.type", 
                    "value": "song"
                }
            }
        }
    }
}

ResumeAction<object@MusicCreativeWork>

User: resume music

Intent Schema:

{
    "intents": [
        {
            "name": "AMAZON.ResumeAction<object@MusicCreativeWork>"
        }
    ]
}

Request:

{
    "request": {
        "type": "IntentRequest", 
        "locale": "en-US", 
        "intent": {
            "name": "AMAZON.ResumeAction<object@MusicCreativeWork>", 
            "slots": {
                "object.type": {
                    "name": "object.type", 
                    "value": "music"
                }
            }
        }
    }
}

SearchAction<object@MusicCreativeWork>

User: can you search my cloud player for an album

Intent Schema:

{
    "intents": [
        {
            "name": "AMAZON.SearchAction<object@MusicCreativeWork>"
        }
    ]
}

Request:

{
    "request": {
        "type": "IntentRequest", 
        "locale": "en-US", 
        "intent": {
            "name": "AMAZON.SearchAction<object@MusicCreativeWork>", 
            "slots": {
                "object.contentSource.owner.name": {
                    "name": "object.contentSource.owner.name", 
                    "value": "my"
                }, 
                "object.contentSource.name": {
                    "name": "object.contentSource.name", 
                    "value": "cloud player"
                }, 
                "object.type": {
                    "name": "object.type", 
                    "value": "album"
                }
            }
        }
    }
}

SearchAction<object@MusicCreativeWork[byArtist]>

User: who is the artist

Intent Schema:

{
    "intents": [
        {
            "name": "AMAZON.SearchAction<object@MusicCreativeWork[byArtist]>"
        }
    ]
}

Request:

{
    "request": {
        "type": "IntentRequest", 
        "locale": "en-US", 
        "intent": {
            "name": "AMAZON.SearchAction<object@MusicCreativeWork[byArtist]>", 
            "slots": {
                "object.byArtist.type": {
                    "name": "object.byArtist.type", 
                    "value": "artist"
                }
            }
        }
    }
}

StartAction<object@MusicCreativeWork>

User: start song from beginning

Intent Schema:

{
    "intents": [
        {
            "name": "AMAZON.StartAction<object@MusicCreativeWork>"
        }
    ]
}

Request:

{
    "request": {
        "type": "IntentRequest", 
        "locale": "en-US", 
        "intent": {
            "name": "AMAZON.StartAction<object@MusicCreativeWork>", 
            "slots": {
                "object.type": {
                    "name": "object.type", 
                    "value": "song"
                }, 
                "object.select": {
                    "name": "object.select", 
                    "value": "beginning"
                }
            }
        }
    }
}

StopAction<object@MusicCreativeWork>

User: stop playing this album

Intent Schema:

{
    "intents": [
        {
            "name": "AMAZON.StopAction<object@MusicCreativeWork>"
        }
    ]
}

Request:

{
    "request": {
        "type": "IntentRequest", 
        "locale": "en-US", 
        "intent": {
            "name": "AMAZON.StopAction<object@MusicCreativeWork>", 
            "slots": {
                "object.type": {
                    "name": "object.type", 
                    "value": "album"
                }
            }
        }
    }
}

SuspendAction<object@MusicCreativeWork>

User: pause music

Intent Schema:

{
    "intents": [
        {
            "name": "AMAZON.SuspendAction<object@MusicCreativeWork>"
        }
    ]
}

Request:

{
    "request": {
        "type": "IntentRequest", 
        "locale": "en-US", 
        "intent": {
            "name": "AMAZON.SuspendAction<object@MusicCreativeWork>", 
            "slots": {
                "object.type": {
                    "name": "object.type", 
                    "value": "music"
                }
            }
        }
    }
}

MusicCreativeWork Slots

The MusicCreativeWork intents can return slot values to your skill. You do not include these slots in your intent schema – they are generated automatically from the intent signature.

Note that not all available slots are returned from every intent. See the table in MusicCreativeWork Intents to see which slots are applicable to each intent.

The following table shows the slots the MusicCreativeWork intents can return. For each slot, the table includes:

  • The slot name.
  • An example utterance for the slot.
  • The JSON that would be sent to your skill for the sample utterance.
  • If applicable, the name of the slot type used by the slot. You can see details about slot types in the Slot Type Reference.
Slot Name Utterance Slot Values

content.amount

"… with all"

 
{
    "name": "content.amount", 
    "value": "all"
}

content.byArtist.name

"… with kiss"

 
{
    "name": "content.byArtist.name", 
    "value": "kiss"
}

content.genre

"… of funk"

AMAZON.Genre

{
    "name": "content.genre", 
    "value": "funk"
}

content.inLanguage.name

"… german"

AMAZON.Language

{
    "name": "content.inLanguage.name", 
    "value": "german"
}

content.owner.name

"… with my"

AMAZON.Person

{
    "name": "content.owner.name", 
    "value": "my"
}

content.type

"… music"

AMAZON.MusicCreativeWorkType

{
    "name": "content.type", 
    "value": "music"
}

object.byArtist.name

"… beyonce"

AMAZON.Artist

{
    "name": "object.byArtist.name", 
    "value": "beyonce"
}

object.byArtist.name

"…play justin timberlake"

AMAZON.Musician

{
    "name": "object.byArtist.name", 
    "value": "justin timberlake"
}

object.byArtist.name

"… by red hot chili peppers"

 
{
    "name": "object.byArtist.name", 
    "value": "red hot chili peppers"
}

object.byArtist.name

"… beyonce"

 
{
    "name": "object.byArtist.name", 
    "value": "beyonce"
}

object.byArtist.type

"…who's playing"

 
{
    "name": "object.byArtist.type", 
    "value": "playing"
}

object.byArtist

"… by this artist"

 
{
    "name": "object.byArtist", 
    "value": "artist"
}

object.composer.name

"…can you play beethoven"

AMAZON.Musician

{
    "name": "object.composer.name", 
    "value": "beethoven"
}

object.contentSource.name

"… cloud player"

 
{
    "name": "object.contentSource.name", 
    "value": "cloud player"
}

object.contentSource.owner.name

"… on my"

AMAZON.Person

{
    "name": "object.contentSource.owner.name", 
    "value": "my"
}

object.contentSource.type

"… collection"

 
{
    "name": "object.contentSource.type", 
    "value": "collection"
}

object.contentSource

"… on audible"

AMAZON.Service

{
    "name": "object.contentSource", 
    "value": "audible"
}

object.era

"…play seventies"

 
{
    "name": "object.era", 
    "value": "seventies"
}

object.genre

"…search for romance"

AMAZON.Genre

{
    "name": "object.genre", 
    "value": "romance"
}

object.inAlbum.type

"…what album's"

AMAZON.MusicCreativeWorkType

{
    "name": "object.inAlbum.type", 
    "value": "album's"
}

object.inLanguage.name

"…do i have any spanish"

AMAZON.Language

{
    "name": "object.inLanguage.name", 
    "value": "spanish"
}

object.name

"…play thriller"

 
{
    "name": "object.name", 
    "value": "thriller"
}

object.owner.name

"…when is my"

AMAZON.Person

{
    "name": "object.owner.name", 
    "value": "my"
}

object.performedIn.name

"… from hamilton"

 
{
    "name": "object.performedIn.name", 
    "value": "hamilton"
}

object.select

"… next"

 
{
    "name": "object.select", 
    "value": "next"
}

object.sort

"… i just added"

 
{
    "name": "object.sort", 
    "value": "just added"
}

object.type

"… music"

AMAZON.MusicCreativeWorkType

{
    "name": "object.type", 
    "value": "music"
}

object.type

"… playlist"

 
{
    "name": "object.type", 
    "value": "playlist"
}

sourceCollection.name

"… off the good music"

AMAZON.MusicPlaylist

{
    "name": "sourceCollection.name", 
    "value": "good music"
}

sourceCollection.owner.name

"…take my"

AMAZON.Person

{
    "name": "sourceCollection.owner.name", 
    "value": "my"
}

sourceCollection.type

"… are on this playlist"

 
{
    "name": "sourceCollection.type", 
    "value": "playlist"
}

sourceCollection.type

"… in the queue"

 
{
    "name": "sourceCollection.type", 
    "value": "queue"
}

targetCollection.name

"… sunday morning"

AMAZON.MusicPlaylist

{
    "name": "targetCollection.name", 
    "value": "sunday morning"
}

targetCollection.owner.name

"…add to my"

AMAZON.Person

{
    "name": "targetCollection.owner.name", 
    "value": "my"
}

targetCollection.type

"… playlist"

 
{
    "name": "targetCollection.type", 
    "value": "playlist"
}

Built-in Intent Library Documentation

MusicCreativeWork is used in the following built-in intent library category:

Navigate to all built-in intents in the Built-in Intent Library.

See all available slot types in the Slot Type Reference.

Learn more about using the built-in intent library:

Learn more about building your voice interface:

The built-in intent library incorporates material from Schema.org, which is licensed under the Creative Commons Attribution-ShareAlike License (version 3.0) (the "License"). You may not use this file except in compliance with the License. You may obtain a copy of the License at http://creativecommons.org/licenses/by-sa/3.0/. For questions, please contact us.

Was this page helpful?

Last updated: Nov 28, 2023