v1

latestSwagger 2.02026-07-17357.0 KB

skill

Retrieve more detailed information about a selected skill.

This endpoint provides more information about a skill than is provided in the available skills endpoint.

get/skill/detail/{skillName}

Path parameters

skillNamestring required

Unique name of the skill to return.

Response

successful operation

categoriesstring[]

All categories related to the skill

descriptionstring

Detailed description of the skill and its capabilities.

iconImagestring uri

Url to an icon image. When provided it will take precedence over the value of the icon field.

isSystemSkillboolean

System skills are treated differently than others in that they are all installed on a device by default and cannot be installed. Volume control is an example.

marketCategorystring

A skill may have many categories. The first category defined is used when displaying the list of available skills.

namestring

uniquely identifying name of skill that is the same as the skill's submodule name in the mycroft-skills Github repository

platformsstring[]

Lists the platforms this skill can run on. Defaults to "any"

{"stackTrail":"components:schemas:SkillDetail:properties:repositoryUrl","oasType":"schema","type":"unknown","description":"A URL representing the Github page for that skill."}

summarystring

A short phrase describing the skill's function

titlestring

triggersstring[]

Examples of a voice commands that trigger the skill.

Example response

[
  {
    "categories": [
      "Music",
      "Entertainment"
    ],
    "credits": {
      "name": "Mycroft AI"
    },
    "icon": {
      "name": "music",
      "color": "#22a7f0"
    },
    "marketCategory": "Music",
    "name": "Spotify",
    "platforms": [
      "Mark I",
      "Mark II"
    ],
    "summary": "Listen to music from your Spotify account",
    "title": "Spotify",
    "triggers": [
      "Play Rush on Spotify",
      "Play Discover Weekly"
    ]
  }
]