Yoto API

https://yoto.dev/api
Admin
The Yoto API provides endpoints for developers to interact with Yoto devices, manage content, handle...
Tokens:34,330
Snippets:171
Trust Score:5.9
Update:1 month ago
Show doc for...
Tokens:
Raw
### Get Device Status Response Example

Source: https://yoto.dev/api/devices/getDeviceStatus

Example JSON response body showing the deviceId and the last update timestamp.

```json
{
  "deviceId": "t21KFoWYO48DwzXPIo7ObZ7U",
  "updatedAt": "2024-04-30T16:51:06.128Z"
}
```

--------------------------------

### Example Response for Get User Icons

Source: https://yoto.dev/api/icons/getUserIcons

The response returns a JSON object containing an array of display icon objects.

```json
{
  "displayIcons": [
    {
      "createdAt": "2025-05-28T16:16:06.451Z",
      "displayIconId": "683736c62fd7c5cd177d206f",
      "mediaId": "XBkuY6DBFn5iRfFS6nV6CTWaCrEvBOOX8nzV9Y64h8I",
      "public": false,
      "url": "https://media-secure-v2-test.aws.fooropa.com/icons/XBkuY6DBFn5iRfFS6nV6CTWaCrEvBOOX8nzV9Y64h8I",
      "userId": "auth0|65afcb79a4f5ae5550e6e63a"
    },
    {
      "createdAt": "2025-05-28T17:38:26.222Z",
      "displayIconId": "68374a1290f87ae7aaa1a6fc",
      "mediaId": "9KPr0oMDLrmVpO-gzJIJs9RmsJHOFlTksV1kTZepFl4",
      "public": false,
      "url": "https://media-secure-v2-test.aws.fooropa.com/icons/9KPr0oMDLrmVpO-gzJIJs9RmsJHOFlTksV1kTZepFl4",
      "userId": "auth0|65afcb79a4f5ae5550e6e63a"
    }
  ]
}
```

--------------------------------

### cURL Request Example

Source: https://yoto.dev/api/content/createorupdatecontent

Example of a cURL command to interact with the content endpoint.

```bash
curl "https://api.yotoplay.com/content"
```

--------------------------------

### Get A Group Response Example

Source: https://yoto.dev/api/family-library-groups/getAGroup

Example JSON response structure for a successful group retrieval request.

```json
{
  "cards": [
    {
      "availability": "free",
      "cardId": "37KwQ",
      "content": {
        "activity": "yoto_Player",
        "chapters": [
          {
            "ambient": null,
            "defaultTrackAmbient": null,
            "defaultTrackDisplay": null,
            "display": {},
            "duration": 0,
            "fileSize": 0,
            "hasStreams": true,
            "key": "ZjjerfMN6",
            "overlayLabel": "1",
            "overlayLabelOverride": null,
            "tracks": [
              {
                "ambient": null,
                "display": null,
                "format": "mp3",
                "key": "vi0LaS7efY",
                "overlayLabel": "1",
                "overlayLabelOverride": null,
                "title": "BBC Radio 1",
                "trackUrl": "http://stream.live.vc.bbcmedia.co.uk/bbc_radio_one",
                "transitions": {},
                "type": "stream"
              }
            ]
          },
          {
            "ambient": null,
            "defaultTrackAmbient": null,
            "defaultTrackDisplay": null,
            "display": {},
            "duration": 0,
            "fileSize": 0,
            "hasStreams": true,
            "key": "R5QS1Mto0",
            "overlayLabel": "2",
            "overlayLabelOverride": null,
            "tracks": [
              {
                "ambient": null,
                "display": null,
                "format": "mp3",
                "key": "BwJKdlUbUm",
                "overlayLabel": "2",
                "overlayLabelOverride": null,
                "title": "BBC Radio 2",
                "trackUrl": "http://stream.live.vc.bbcmedia.co.uk/bbc_radio_two",
                "transitions": {},
                "type": "stream"
              }
            ]
          },
          {
            "ambient": null,
            "defaultTrackAmbient": null,
            "defaultTrackDisplay": null,
            "display": {},
            "duration": 0,
            "fileSize": 0,
            "hasStreams": true,
            "key": "IIPNvhWrh",
            "overlayLabel": "3",
            "overlayLabelOverride": null,
            "tracks": [
              {
                "ambient": null,
                "display": null,
                "format": "mp3",
                "key": "-HyLtuQraF",
                "overlayLabel": "3",
                "overlayLabelOverride": null,
                "title": "BBC Radio 3",
                "trackUrl": "http://stream.live.vc.bbcmedia.co.uk/bbc_radio_three",
                "transitions": {},
                "type": "stream"
              }
            ]
          }
```

--------------------------------

### Successful Response Example

Source: https://yoto.dev/api/content/createorupdatecontent

Example of a successful 200 OK response containing the card object.

```json
{
  "card": {
    "_id": "676016ea43bedbaa54a70549",
    "cardId": "31yYU",
    "content": {
      "chapters": [],
      "config": {
        "resumeTimeout": 2592000
      },
      "playbackType": "linear"
    },
    "createdAt": "2024-12-16T12:02:50.164Z",
    "metadata": {},
    "title": "Testing Podcast",
    "updatedAt": "2024-12-16T12:02:50.164Z",
    "userId": "2kRM9HdDaanNVdLqnjn1d5xFH46Ffmkh@clients"
  }
}
```

--------------------------------

### Error Response Example

Source: https://yoto.dev/api/content/createorupdatecontent

Example of a 400 Bad Request response when attempting to restore a deleted card.

```json
{
  "error": {
    "code": "bad-request",
    "message": "Deleted card cannot be restored"
  }
}
```

--------------------------------

### Get Device Config cURL Request

Source: https://yoto.dev/api/devices/getdeviceconfig

Example cURL command to retrieve device configuration using the device ID.

```bash
curl "https://api.yotoplay.com/device-v2/{deviceId}/config"
```

--------------------------------

### cURL Upload Request

Source: https://yoto.dev/api/icons/uploadCustomIcon

Example command to upload an icon using cURL.

```bash
curl "https://api.yotoplay.com/media/displayIcons/user/me/upload"
```

--------------------------------

### Response Schema Example

Source: https://yoto.dev/api/media/getAnUploadUrl

Example JSON response structure returned by the endpoint.

```json
{
  "upload": {
    "uploadId": "zK3NQ1r-P7mQd9IjOKVFjlWnYAuGn3nHWTJSejljJcM",
    "uploadUrl": null
  }
}
```

--------------------------------

### Get Upload URL via cURL

Source: https://yoto.dev/api/media/getAnUploadUrl

Example request to the upload URL endpoint using cURL.

```bash
curl "https://api.yotoplay.com/media/transcode/audio/uploadUrl"
```

--------------------------------

### Device Configuration JSON Response

Source: https://yoto.dev/api/devices/getdeviceconfig

Example of the JSON object returned when successfully querying a device's configuration.

```json
{
  "device": {
    "config": {
      "alarms": [],
      "ambientColour": "#ff0000",
      "bluetoothEnabled": "0",
      "btHeadphonesEnabled": true,
      "clockFace": "digital-sun",
      "dayDisplayBrightness": "auto",
      "dayTime": "07:30",
      "dayYotoDaily": "3nC80/daily/<yyyymmdd>",
      "dayYotoRadio": "3nC80/radio-day/01",
      "displayDimBrightness": "0",
      "displayDimTimeout": "60",
      "headphonesVolumeLimited": false,
      "hourFormat": "12",
      "maxVolumeLimit": "16",
      "nightAmbientColour": "#ff0000",
      "nightDisplayBrightness": "auto",
      "nightMaxVolumeLimit": "16",
      "nightTime": "19:30",
      "nightYotoDaily": "3nC80/daily/<yyyymmdd>",
      "nightYotoRadio": "3nC80/radio-night/01",
      "repeatAll": false,
      "shutdownTimeout": "3600",
      "volumeLevel": "safe"
    },
    "deviceFamily": "v2",
    "deviceGroup": "",
    "deviceId": "t21KFoWYO48DwzXPIo7ObZ7U",
    "deviceType": "v2",
    "errorCode": null,
    "geoTimezone": "Europe/London",
    "getPosix": "GMT0BST,M3.5.0/1,M10.5.0",
    "mac": "9C-B6-D0-BF-4A-27",
    "online": false,
    "registrationCode": "MATEZRAA",
    "releaseChannelId": "general",
    "releaseChannelVersion": "v2.1.102",
    "shortcuts": {
      "modes": {
        "day": {
          "content": [
            {
              "cmd": "track-play",
              "params": {
                "card": "3nC80",
                "chapter": "daily",
                "track": "<yyyymmdd>"
              }
            },
            {
              "cmd": "track-play",
              "params": {
                "card": "3nC80",
                "chapter": "radio-day",
                "track": "01"
              }
            }
          ]
        },
        "night": {
          "content": [
            {
              "cmd": "track-play",
              "params": {
                "card": "3nC80",
                "chapter": "daily",
                "track": "<yyyymmdd>"
              }
            },
            {
              "cmd": "track-play",
              "params": {
                "card": "3nC80",
                "chapter": "radio-night",
                "track": "01"
              }
            }
          ]
        }
      },
      "versionId": "36645a9463e038d6cb9923257b38d9d9df7a6509"
    }
  }
}
```

--------------------------------

### Retrieve Devices via cURL

Source: https://yoto.dev/api/devices/getDevices

Example cURL command to fetch the list of devices from the Yoto API.

```bash
curl "https://api.yotoplay.com/device-v2/devices/mine"
```

--------------------------------

### cURL Request Example

Source: https://yoto.dev/api/family/getFamilyImages

A basic cURL command to fetch family images from the Yoto API.

```bash
curl "https://api.yotoplay.com/media/family/images"
```

--------------------------------

### Get Device Status cURL Request

Source: https://yoto.dev/api/devices/getDeviceStatus

Example cURL command to retrieve device status using the device-v2 endpoint.

```bash
curl "https://api.yotoplay.com/device-v2/{deviceId}/status"
```

--------------------------------

### 200 OK Response Schema

Source: https://yoto.dev/api/icons/uploadCustomIcon

Example of a successful 200 OK response for the icon upload endpoint.

```json
{
  "displayIcon": {
    "displayIconId": "688237b96dbfcfbe1b594350",
    "mediaId": "zbFJyjjwsIkOch_Ym8qy0dCU20oDODkBz_YEylgG6gg",
    "new": true,
    "url": "https://media-secure-v2-test.aws.fooropa.com/icons/zbFJyjjwsIkOch_Ym8qy0dCU20oDODkBz_YEylgG6gg",
    "userId": "auth0|65afcb79a4f5ae5550e6e63a"
  }
}
```

--------------------------------

### GET /icons

Source: https://yoto.dev/api/icons/getPublicIcons

Retrieves a list of public display icons.

```APIDOC
## GET /icons

### Description
Retrieves a list of all public display icons available in the system.

### Method
GET

### Endpoint
/icons

### Response
#### Success Response (200)
- **displayIcons** (array) - A list of icon objects.

#### Response Example
{
  "displayIcons": [
    {
      "createdAt": "2024-11-18T17:21:23.568Z",
      "displayIconId": "673b779314f1f54038881d6e",
      "mediaId": "7Wt--qhx9t7PCSC8WBmGKJvlG53Z1uk7bN1dE9wGWJ0",
      "new": true,
      "public": true,
      "publicTags": ["happy", "seedling", "plant"],
      "title": "Happy Seedling Plant",
      "url": "https://media-secure-v2-test.aws.fooropa.com/icons/7Wt--qhx9t7PCSC8WBmGKJvlG53Z1uk7bN1dE9wGWJ0",
      "userId": "yoto"
    }
  ]
}
```

--------------------------------

### Retrieve Content Response Example

Source: https://yoto.dev/api/content/getContent

Successful response structure for a content retrieval request.

```json
{
  "card": {
    "cardId": "iMG7o",
    "content": {
      "activity": "yoto_Player",
      "chapters": [],
      "config": {},
      "editSettings": {
        "autoOverlayLabels": "disabled",
        "editKeys": false,
        "transcodeAudioUploads": true
      },
      "version": "1"
    },
    "createdAt": "2021-05-07T14:08:26.435Z",
    "creatorEmail": "theresa.may.1@yotoplay.com",
    "deleted": false,
    "metadata": {
      "category": "none",
      "cover": {},
      "media": {
        "duration": 1419,
        "fileSize": 0,
        "hasStreams": false
      }
    },
    "shareLimit": 0,
    "shareLinkCreatedAt": "2022-03-03T00:00:00.000Z",
    "slug": "5VmJm1wxphhSh0by74XQbw",
    "title": "something blah",
    "updatedAt": "2023-06-22T10:16:53.717Z",
    "userId": "auth0|65afcb79a4f5ae5550e6e63a"
  }
}
```

--------------------------------

### Binary Image Response

Source: https://yoto.dev/api/family/getAFamilyImage

Example of the raw binary data returned in a successful response.

```text
"PNG

���
IHDR��@��@���͐���	pHYs������� �IDATxlwtu@FzBׄ{	.3StOoNݎ8@Dg X#-<뺑O_EIrgW]q%8Iw|[G۲5چ-*"Td]�9JrV)QJ! ue*H\b#HI"qm]@b'"m'r1lVR@%r6d{1rv*`O	r'))IUq MIi%JUPֆv4ѼɎ"{ڶ:йIkݻ8[n-{ѿ_O_}K0Wf@Jg\.sfDh3n0Zh+CΌָ1"}61Ti`\G3õntiګL^׹3RD#&ݘjrgɃw,hJrfd5'9>՜h'97L.pZnĭ3xB9\okMzן/y.^y&^^KWpn^\/yf^_rxb/yru̝kn<9S3xq~9,B.qTCɔ'BIt/frUx:(qlOGj:ҸJM z:tiqq=
g2G:Ѱԑ敎9ItҹZCg(]Zz&8`=JMW=:%hғ`?YOD-}Zz'$b&Mї7I#ѓ;Iˡ$#:ړhNr)IM}cr40vڰ߆_jǚd.#} iH%͖[leq`evTvߞ~4:@j{:0g$QDx Sj梴Ip>Օǒ,3p93dxt޼W^"u1ۺ\Oxw?oo[[Ep*\o>q/K>Ϗxl5
MQ_ħMQ|TGiNK45EImw"/l?wey D ۓh`ol/$Ɂ${Ǝ{۳7֞1v슱ek%!
_d\_>o$RA
DhCbUm[l'I0jUD-%f1r(Fъo	PHOTH,OWHVr0׆564)ߎ捶nȞm tlwC#	
zhݫwNz
	JP_b`RCef-*31\jaԙ52X3S5 LV3^Θ[
#zטvL#.z0d'uY8H'z}91SAp'C8=9IiZ+֩m<}v_zןcy{^ C�o<+*^VKWvխ|f^/ kl#w.F�n-7WǼ:ε1WnLz"^ͱ\6gtue$[e]*#]AI*o-6x+I)lG#K iꯓ(/PKUV
V:Ҵ܉F!ejZV:ov
t3'V/}72f`$pTg$UxL FfOҗl'Eˡd::4�RiR*҉p5j;'ȁlp= W8Pҁ-f}>Q`Ou5:R1XMs#:5D	Hd#Ӝ93"M3s6twexp5.<S9v xi'Qmn~c9,YBxh%n\/
Ku
~͇_U!_.
@>
X>mNS$Où8h~k,뢸W.ν  >$ގ&(OVR<F,Ue%EI>	ĩ(a_QJvGd[PJ6(X WA*>JE2\$k*R)H^$q$6D-TmCB;RDN
Ar
E)x(Ab+@)9e
3TfQq0זu%hKK
mlIp7"H.G:᷅طO+~!	),3Xj`耙gKݮo z1_ OjraʙJ5U43Peaʕ:wI~ndzw9t;MVfZpc	Dh'83HN Frv$'Sx|:K3kvd#7OܾRk7sü8o2͏_3?|q<wWo4|u?/mM|%r}>ҹ}.!<+76Q WFybܝn/r*һՁ\{c)"P`/G;9ؐaYD�uy$@!?i#˝g*':tj_Mw0-=:z3H41ad8MX,$<,Ftf63g
```

--------------------------------

### Retrieve MYO Content via cURL

Source: https://yoto.dev/api/content/getUserSMyoContent

Example request to fetch the authenticated user's MYO content.

```bash
curl "https://api.yotoplay.com/content/mine"
```

--------------------------------

### Group Creation Response Schema

Source: https://yoto.dev/api/family-library-groups/createAGroup

Example JSON response structure returned upon successfully creating a group.

```json
{
  "cards": [
    {
      "availability": "free",
      "cardId": "37KwQ",
      "content": {
        "activity": "yoto_Player",
        "chapters": [
          {
            "ambient": null,
            "defaultTrackAmbient": null,
            "defaultTrackDisplay": null,
            "display": {},
            "duration": 0,
            "fileSize": 0,
            "hasStreams": true,
            "key": "ZjjerfMN6",
            "overlayLabel": "1",
            "overlayLabelOverride": null,
            "tracks": [
              {
                "ambient": null,
                "display": null,
                "format": "mp3",
                "key": "vi0LaS7efY",
                "overlayLabel": "1",
                "overlayLabelOverride": null,
                "title": "BBC Radio 1",
                "trackUrl": "http://stream.live.vc.bbcmedia.co.uk/bbc_radio_one",
                "transitions": {},
                "type": "stream"
              }
            ]
          },
          {
            "ambient": null,
            "defaultTrackAmbient": null,
            "defaultTrackDisplay": null,
            "display": {},
            "duration": 0,
            "fileSize": 0,
            "hasStreams": true,
            "key": "R5QS1Mto0",
            "overlayLabel": "2",
            "overlayLabelOverride": null,
            "tracks": [
              {
                "ambient": null,
                "display": null,
                "format": "mp3",
                "key": "BwJKdlUbUm",
                "overlayLabel": "2",
                "overlayLabelOverride": null,
                "title": "BBC Radio 2",
                "trackUrl": "http://stream.live.vc.bbcmedia.co.uk/bbc_radio_two",
                "transitions": {},
                "type": "stream"
              }
            ]
          },
          {
            "ambient": null,
            "defaultTrackAmbient": null,
            "defaultTrackDisplay": null,
            "display": {},
            "duration": 0,
            "fileSize": 0,
            "hasStreams": true,
            "key": "IIPNvhWrh",
            "overlayLabel": "3",
            "overlayLabelOverride": null,
            "tracks": [
              {
```

--------------------------------

### Update device shortcuts cURL request

Source: https://yoto.dev/api/devices/updateShortcutsBeta

Example cURL command to trigger the shortcut update endpoint.

```bash
curl "https://api.yotoplay.com/device-v2/{deviceId}/shortcuts"
```

--------------------------------

### Exchange Token Request cURL

Source: https://yoto.dev/api/authentication/post-oauth-token

Example cURL command to perform the token exchange request.

```bash
curl "https://login.yotoplay.com/oauth/token"
```

--------------------------------

### Example Group Response JSON

Source: https://yoto.dev/api/family-library-groups/createagroup

The structure of the JSON response returned upon successfully creating a group.

```json
{
  "cards": [
    {
      "availability": "free",
      "cardId": "37KwQ",
      "content": {
        "activity": "yoto_Player",
        "chapters": [
          {
            "ambient": null,
            "defaultTrackAmbient": null,
            "defaultTrackDisplay": null,
            "display": {},
            "duration": 0,
            "fileSize": 0,
            "hasStreams": true,
            "key": "ZjjerfMN6",
            "overlayLabel": "1",
            "overlayLabelOverride": null,
            "tracks": [
              {
                "ambient": null,
                "display": null,
                "format": "mp3",
                "key": "vi0LaS7efY",
                "overlayLabel": "1",
                "overlayLabelOverride": null,
                "title": "BBC Radio 1",
                "trackUrl": "http://stream.live.vc.bbcmedia.co.uk/bbc_radio_one",
                "transitions": {},
                "type": "stream"
              }
            ]
          },
          {
            "ambient": null,
            "defaultTrackAmbient": null,
            "defaultTrackDisplay": null,
            "display": {},
            "duration": 0,
            "fileSize": 0,
            "hasStreams": true,
            "key": "R5QS1Mto0",
            "overlayLabel": "2",
            "overlayLabelOverride": null,
            "tracks": [
              {
                "ambient": null,
                "display": null,
                "format": "mp3",
                "key": "BwJKdlUbUm",
                "overlayLabel": "2",
                "overlayLabelOverride": null,
                "title": "BBC Radio 2",
                "trackUrl": "http://stream.live.vc.bbcmedia.co.uk/bbc_radio_two",
                "transitions": {},
                "type": "stream"
              }
            ]
          },
          {
            "ambient": null,
            "defaultTrackAmbient": null,
            "defaultTrackDisplay": null,
            "display": {},
            "duration": 0,
            "fileSize": 0,
            "hasStreams": true,
            "key": "IIPNvhWrh",
            "overlayLabel": "3",
            "overlayLabelOverride": null,
            "tracks": [
```

--------------------------------

### Upload Cover Image cURL Request

Source: https://yoto.dev/api/media/uploadCoverImage

Example cURL command to trigger the cover image upload endpoint.

```bash
curl "https://api.yotoplay.com/media/coverImage/user/me/upload"
```

--------------------------------

### Device List Response Schema

Source: https://yoto.dev/api/devices/getDevices

Example JSON response structure returned by the API upon a successful request.

```json
{
  "devices": [
    {
      "description": "late.smoke",
      "deviceFamily": "v2",
      "deviceGroup": "",
      "deviceId": "t2iumaiU2bEmyQJ4JSXZQZPh",
      "deviceType": "v2",
      "name": "Player 2",
      "online": false,
      "releaseChannel": "general"
    },
    {
      "description": "square.union",
      "deviceFamily": "v2",
      "deviceGroup": "",
      "deviceId": "t21KFoWYO48DwzXPIo7ObZ7U",
      "deviceType": "v2",
      "name": "V2 player",
      "online": false,
      "releaseChannel": "general"
    }
  ]
}
```

--------------------------------

### MYO Content Response Schema

Source: https://yoto.dev/api/content/getUserSMyoContent

Example JSON structure returned by the /content/mine endpoint.

```json
{
  "cards": [
    {
      "availability": "free",
      "cardId": "string",
      "clubAvailability": [
        {
          "store": "string"
        }
      ],
      "content": {
        "activity": "yoto_Player",
        "config": {
          "autoadvance": "repeat",
          "onlineOnly": true,
          "shuffle": [
            {
              "end": 0,
              "limit": 0,
              "start": 0
            }
          ],
          "trackNumberOverlayTimeout": 0
        },
        "cover": {
          "imageL": null
        },
        "editSettings": {
          "autoOverlayLabels": "disabled",
          "editKeys": true,
          "podcastTrackDisplay": {
            "icon16x16": "string"
          },
          "podcastType": "managed"
        },
        "hidden": true,
        "restricted": true,
        "version": "string"
      },
      "createdAt": "string",
      "deleted": true,
      "metadata": {
        "author": "string",
        "category": "stories",
        "cover": {
          "imageL": null
        },
        "description": "string",
        "feedUrl": null,
        "hidden": true,
        "languages": [
          "string"
        ],
        "list": [
          null
        ],
        "media": {
          "duration": 0,
          "fileSize": 0,
          "hasStreams": true
        },
        "note": "string",
        "order": null,
        "previewAudio": "string",
        "share": true,
        "status": {
          "name": "inprogress",
          "updatedAt": "string"
        }
      },
      "shareLinkCreatedAt": "string",
      "shareLinkUrl": "string",
      "sharing": {
        "linkCreatedAt": "string",
        "linkUrl": "string",
        "shareCount": 0,
        "shareLimit": 0
      },
      "slug": "string",
      "sortkey": "string",
      "title": "string",
      "updatedAt": "string",
      "userId": "string"
    }
  ]
}
```

--------------------------------

### Retrieve Family Image via cURL

Source: https://yoto.dev/api/family/getafamilyimage

Example request to fetch a family image using the cURL command-line tool.

```bash
curl "https://api.yotoplay.com/media/family/images/1afea16db1aeb62f8ba84cdb191eee7c1dd734d23098b4756717c3e2bded8c6a"
```

--------------------------------

### POST /oauth/device/code

Source: https://yoto.dev/api/authentication/post-oauth-device-code

Starts the OAuth2 Device Authorization flow to obtain a device code and user verification details.

```APIDOC
## POST /oauth/device/code

### Description
Start the OAuth2 Device Authorization flow for CLI/server-side applications.

### Method
POST

### Endpoint
https://login.yotoplay.com/oauth/device/code

### Request Body
- **client_id** (string) - Required - The client identifier.
- **scope** (string) - Required - The requested scopes (e.g., "profile offline_access").
- **audience** (string) - Required - The intended audience for the token (e.g., "https://api.yotoplay.com").

### Request Example
{
  "client_id": "string",
  "scope": "profile offline_access",
  "audience": "https://api.yotoplay.com"
}

### Response
#### Success Response (200)
- **device_code** (string) - The device verification code
- **user_code** (string) - The code displayed to the user
- **verification_uri** (string) - The URL where the user should enter the user_code
- **verification_uri_complete** (string) - The verification URL with the code included
- **expires_in** (integer) - The lifetime of the device code in seconds
- **interval** (integer) - Minimum polling interval in seconds

#### Response Example
{
  "device_code": "string",
  "user_code": "string",
  "verification_uri": "https://example.com",
  "verification_uri_complete": "https://example.com",
  "expires_in": 0,
  "interval": 0
}

#### Error Response (400)
- **error** (string) - Error code (invalid_request, unauthorized_client, access_denied, invalid_scope)
- **error_description** (string) - Description of the error
```

--------------------------------

### Delete Content Request Example

Source: https://yoto.dev/api/content/deletecontent

A cURL command to perform a DELETE request for a specific card ID.

```bash
curl "https://api.yotoplay.com/content/{cardId}"
```

--------------------------------

### Group Update Response JSON

Source: https://yoto.dev/api/family-library-groups/updateagroup

Example of the JSON structure returned upon a successful group update request.

```json
{
  "cards": [
    {
      "availability": "premium",
      "cardId": "5IiME",
      "content": {
        "activity": "yoto_Player",
        "chapters": [
          {
            "ambient": null,
            "defaultTrackAmbient": null,
            "defaultTrackDisplay": null,
            "display": {
              "icon16x16": "yoto:#f9yadvT_NnXvq6di120C7gOVFv9puAIAEvopzTAJUoc"
            },
            "key": "01",
            "overlayLabel": "1",
            "overlayLabelOverride": "1",
            "title": "Flight of the Bumblebee",
            "tracks": [
              {
                "ambient": null,
                "display": {
                  "icon16x16": "yoto:#f9yadvT_NnXvq6di120C7gOVFv9puAIAEvopzTAJUoc"
                },
                "format": "aac",
                "key": "01",
                "title": "Flight of the Bumblebee",
                "trackUrl": "yoto:#NudzVLThRTvNB1gFpIehxnw1Y2h-1X1qYH2hOaEC8Sk",
                "type": "audio"
              }
            ]
          },
          {
            "ambient": null,
            "defaultTrackAmbient": null,
            "defaultTrackDisplay": null,
            "display": {
              "icon16x16": "yoto:#i7gtJOewdaEQipPSaEzNuMLge_YZRdkKBgsDUbBdURg"
            },
            "key": "02",
            "overlayLabel": "2",
            "overlayLabelOverride": "2",
            "title": "Allegro",
            "tracks": [
              {
                "ambient": null,
                "display": {
                  "icon16x16": "yoto:#i7gtJOewdaEQipPSaEzNuMLge_YZRdkKBgsDUbBdURg"
                },
                "format": "aac",
                "key": "02",
                "title": "Allegro",
                "trackUrl": "yoto:#J2FuNSy8uY08QB49lVW--RftZhXnBdtrpi0Td2zCWiU",
                "type": "audio"
              }
            ]
          },
          {
            "ambient": null,
            "defaultTrackAmbient": null,
            "defaultTrackDisplay": null,
            "display": {
              "icon16x16": "yoto:#ifiMh5pERuDpVufVWkM_EXBxVYHthkZ-vhaqD3fbMy4"
            },
            "key": "03",
            "overlayLabel": "3",
            "overlayLabelOverride": "3",
            "title": "March No. 1",
            "tracks": [
              {
                "ambient": null,
                "display": {
                  "icon16x16": "yoto:#ifiMh5pERuDpVufVWkM_EXBxVYHthkZ-vhaqD3fbMy4"
                },
                "format": "aac",
                "key": "03",
                "title": "March No. 1",
                "trackUrl": "yoto:#HmL1tk1E-CiEaciE6G5MsdTCTr_6I2fHq8Hbjq5nxlE",
                "type": "audio"
              }
            ]
          },
          {
            "ambient": null,
            "defaultTrackAmbient": null,
            "defaultTrackDisplay": null,
            "display": {
              "icon16x16": "yoto:#ZUM27Zq3bSfQG6-wrwx3P8ABUZQWoY3k0RE6ddRSS2s"
            },
            "key": "04",
            "overlayLabel": "4",
            "overlayLabelOverride": "4",
            "title": "The Cat",
            "tracks": [
              {
                "ambient": null,
                "display": {
                  "icon16x16": "yoto:#ZUM27Zq3bSfQG6-wrwx3P8ABUZQWoY3k0RE6ddRSS2s"
                },
                "format": "aac",
                "key": "04",
                "title": "The Cat",
                "trackUrl": "yoto:#G8waAF6OxDdmPer26Yg8dxAfm57YumK0ZyDz_PIQYws",
                "type": "audio"
              }
            ]
          }
```

--------------------------------

### GET /authorize

Source: https://yoto.dev/api/authentication/get-authorize

Redirects the user to Yoto's login page to begin the OAuth2 Authorization Code flow.

```APIDOC
## GET /authorize

### Description
Redirects the user to Yoto's login page to begin the OAuth2 Authorization Code flow.

### Method
GET

### Endpoint
https://login.yotoplay.com/authorize

### Parameters
#### Query Parameters
- **audience** (string) - Required - The intended audience for the token.
- **scope** (string) - Required - The requested scopes.
- **response_type** (string) - Required - The type of response expected (e.g., code, token, id_token).
- **client_id** (string) - Required - The client identifier.
- **redirect_uri** (string) - Required - The URI to redirect to after authorization.
- **state** (string) - Required - Opaque value for preventing CSRF attacks.
- **nonce** (string) - Optional - String value to prevent replay attacks.
- **prompt** (string) - Optional - Specifies the authorization server prompt behavior.
- **max_age** (integer) - Optional - Maximum authentication age in seconds.
- **code_challenge** (string) - Optional - PKCE code challenge.
- **code_challenge_method** (string) - Optional - PKCE code challenge method.

### Response
#### Success Response (302)
- Redirects to login page or callback URL.

#### Error Response (400)
- **error** (string) - The error code (e.g., invalid_request, unauthorized_client).
- **error_description** (string) - Description of the error.
- **error_uri** (string) - URI for more information about the error.

#### Response Example
{
  "error": "invalid_request",
  "error_description": "string",
  "error_uri": "https://example.com"
}
```

--------------------------------

### Initialize Device Authorization Request

Source: https://yoto.dev/api/authentication/post-oauth-device-code

A cURL command to initiate the device authorization flow.

```bash
curl "https://login.yotoplay.com/oauth/device/code"
```

--------------------------------

### Send Device Command via cURL

Source: https://yoto.dev/api/devices/sendDeviceCommand

Example request to send a command to a device using the cURL command-line tool.

```bash
curl "https://api.yotoplay.com/device-v2/{deviceId}/command/status"
```

--------------------------------

### GET /media/displayIcons/user/yoto

Source: https://yoto.dev/api/icons/getpublicicons

Retrieves the display icons for the specified user.

```APIDOC
## GET /media/displayIcons/user/yoto

### Description
Retrieves the display icons for the specified user.

### Method
GET

### Endpoint
https://api.yotoplay.com/media/displayIcons/user/yoto

### Request Example
curl "https://api.yotoplay.com/media/displayIcons/user/yoto"
```

--------------------------------

### GET /card/family/library/groups

Source: https://yoto.dev/api/family-library-groups/getGroups

Retrieves all family library groups for a family.

```APIDOC
## GET /card/family/library/groups

### Description
Gets all family library groups for a family. If there are no groups, it returns an empty array.

### Method
GET

### Endpoint
https://api.yotoplay.com/card/family/library/groups

### Required Scope
family:library:view

### Response
#### Success Response (200)
- **cards** (array) - List of library group objects

#### Response Example
[
  {
    "cards": [],
    "createdAt": "2024-09-27T15:30:05.433Z",
    "familyId": "65b120377258d846de4595d8",
    "id": "xHE4ZtAHbQ2f0EXlmCUxi",
    "imageId": "fp-cards",
    "imageUrl": "https://cdn.yoto.io/library/groups/fp-cards.png",
    "items": [
      {
        "addedAt": "2024-09-27T15:30:05.447Z",
        "contentId": "37KwQ"
      },
      {
        "addedAt": "2024-09-27T15:30:05.447Z",
        "contentId": "feNkK"
      }
    ],
    "lastModifiedAt": "2024-09-27T15:30:05.433Z",
    "name": "My Favourites"
  }
]
```

--------------------------------

### GET /media/displayIcons/user/me

Source: https://yoto.dev/api/icons/getUserIcons

Retrieves the custom icons associated with the authenticated user.

```APIDOC
## GET /media/displayIcons/user/me

### Description
Retrieves the custom icons associated with the authenticated user.

### Method
GET

### Endpoint
https://api.yotoplay.com/media/displayIcons/user/me

### Required Scope
user:icons:manage

### Response
#### Success Response (200)
- **displayIcons** (array) - A list of user icon objects.
  - **mediaId** (string) - A unique identifier for the underlying icon file.
  - **userId** (string) - The ID of the user who uploaded this icon.
  - **createdAt** (string) - The timestamp (UTC) when this display icon record was created.
  - **url** (string) - A publicly accessible icon URL.
  - **public** (boolean) - Indicates if the display icon is public.
  - **displayIconId** (string) - Unique identifier for the icon.

#### Response Example
{
  "displayIcons": [
    {
      "createdAt": "2025-05-28T16:16:06.451Z",
      "displayIconId": "683736c62fd7c5cd177d206f",
      "mediaId": "XBkuY6DBFn5iRfFS6nV6CTWaCrEvBOOX8nzV9Y64h8I",
      "public": false,
      "url": "https://media-secure-v2-test.aws.fooropa.com/icons/XBkuY6DBFn5iRfFS6nV6CTWaCrEvBOOX8nzV9Y64h8I",
      "userId": "auth0|65afcb79a4f5ae5550e6e63a"
    }
  ]
}
```

--------------------------------

### Update Device Configuration Request

Source: https://yoto.dev/api/devices/updatedeviceconfig

Example payload for updating device settings including ambient colors, brightness, and volume limits.

```json
{ "config": { "alarms": [], "ambientColour": "#ff3900", "bluetoothEnabled": "1", "btHeadphonesEnabled": true, "clockFace": "digital-sun", "dayDisplayBrightness": "auto", "dayTime": "07:30", "dayYotoDaily": "3nC80/daily/<yyyymmdd>", "dayYotoRadio": "3nC80/radio-day/01", "displayDimBrightness": "0", "displayDimTimeout": "60", "headphonesVolumeLimited": false, "hourFormat": "24", "locale": "en", "maxVolumeLimit": "16", "nightAmbientColour": "#ff0000", "nightDisplayBrightness": "auto", "nightMaxVolumeLimit": "16", "nightTime": "22:01", "nightYotoDaily": "3nC80/daily/<yyyymmdd>", "nightYotoRadio": "3nC80/radio-night/01", "repeatAll": false, "shutdownTimeout": "3600", "volumeLevel": "safe" }, "name": "V2 player" }
```

--------------------------------

### GET /device-v2/devices/mine

Source: https://yoto.dev/api/devices/getdevices

Retrieves the list of devices associated with the authenticated user.

```APIDOC
## GET /device-v2/devices/mine

### Description
This endpoint retrieves the list of devices associated with the authenticated user. It allows users to view their devices and whether the device appears to be online.

### Method
GET

### Endpoint
https://api.yotoplay.com/device-v2/devices/mine

### Required Scope
family:devices:view

### Response
#### Success Response (200)
- **devices** (array) - An array of device objects.
  - **deviceId** (string) - The unique identifier for the device.
  - **name** (string) - The name of the device.
  - **description** (string) - A brief description of the device.
  - **online** (boolean) - Indicates whether the device is currently online.
  - **releaseChannel** (string) - The release channel of the device.
  - **deviceType** (string) - The type of the device.
  - **deviceFamily** (string) - The family to which the device belongs.
  - **deviceGroup** (string) - The group classification of the device.

#### Response Example
{
  "devices": [
    {
      "description": "late.smoke",
      "deviceFamily": "v2",
      "deviceGroup": "",
      "deviceId": "t2iumaiU2bEmyQJ4JSXZQZPh",
      "deviceType": "v2",
      "name": "Player 2",
      "online": false,
      "releaseChannel": "general"
    }
  ]
}
```
Tokens:
Raw