> ## Documentation Index > Fetch the complete documentation index at: https://docs.scraperize.com/llms.txt > Use this file to discover all available pages before exploring further. # Album > Returns an Apple Music album by id or link: name, artists, genres, release date, copyright, Apple's editorial notes, explicit flag, audio badges (Dolby Atmos, Lossless, Hi-Res Lossless, Apple Digital Master), price, track count and total length, cover, editorial and motion artwork, and every track — number, disc, name, length, credited artist, composer, a 30-second preview, explicit flag and Apple's "popular" mark — plus other versions, its music videos, more by the artist, playlists it's featured on and similar albums. Only publicly available data is returned. > [!NOTE] > > **Cost: 1 credit** per successful request. Errors and cache hits (`cache_max_age`) are free. > [accordion] Copy for AI assistant > > Paste this into ChatGPT, Claude or your coding assistant to generate working code for this endpoint (use the copy button). > > ```text Prompt > I want to make an API call to /v1/apple-music/album. Here are the details: > > Endpoint: GET https://api.scraperize.com/v1/apple-music/album > Description: Returns an Apple Music album by id or link: name, artists, genres, release date, copyright, Apple's editorial notes, explicit flag, audio badges (Dolby Atmos, Lossless, Hi-Res Lossless, Apple Digital Master), price, track count and total length, cover, editorial and motion artwork, and every track — number, disc, name, length, credited artist, composer, a 30-second preview, explicit flag and Apple's "popular" mark — plus other versions, its music videos, more by the artist, playlists it's featured on and similar albums. Only publicly available data is returned. > > Required Headers: > - x-api-key: Your API key > > Parameters: > - id (string): The album's Apple Music id (digits). Required unless `url` is given. Looked up in the US storefront. > - url (string): The album's music.apple.com link. Required unless `id` is given. The link's storefront (country) is used. > - cache_max_age (select): Optional. Return a cached result if one this age or newer exists — served for **0 credits** with `meta.cached=true` and `meta.cachedAt`. Otherwise a fresh scrape runs (**1 credit**) and refreshes the cache. Omit to always scrape fresh. > > Example Response: > { > "data": { > "id": "1528112358", > "name": "folklore (deluxe version)", > "url": "https://music.apple.com/us/album/folklore-deluxe-version/1528112358", > "artists": [ > { > "id": "159260351", > "name": "Taylor Swift", > "url": "https://music.apple.com/us/artist/taylor-swift/159260351" > } > ], > "genres": [ > "Alternative" > ], > "releaseDate": "2020-07-24", > "copyright": "℗ 2020 Taylor Swift", > "description": "A mere 11 months passed between the release of Lover and its surprise follow-up, but it feels like a lifetime. Written and recorded remotely during the first fe…", > "isExplicit": true, > "trackCount": 17, > "durationMs": 4028392, > "artworkUrl": "https://is1-ssl.mzstatic.com/image/thumb/Music115/v4/b5/80/dc/b580dca0-349d-036b-e09b-bd849f6affd8/20UMGIM64216.rgb.jpg/3000x3000bb.jpg", > "editorialArtworkUrl": "https://is1-ssl.mzstatic.com/image/thumb/Features114/v4/53/4c/b1/534cb156-9112-f7a0-83d7-6e3f2b090352/U0RTLU1TLVdXLVRheWxvcl9Td2lmdF9Gb2xrbG9yZS1BREFNX0lEPTE1Mj…", > "motionArtworkUrl": "https://mvod.itunes.apple.com/itunes-assets/HLSMusic125/v4/27/b4/5b/27b45bdd-aba1-8f0f-d9f8-17402222f215/P359221400_default.m3u8", > "audioBadges": { > "dolbyAtmos": true, > "dolbyAudio": false, > "lossless": true, > "hiResLossless": false, > "digitalMaster": true > }, > "offers": [ > { > "type": "buy", > "price": 13.99, > "priceFormatted": "$13.99" > } > ], > "tracks": [ > { > "id": "1528112361", > "name": "the 1", > "url": "https://music.apple.com/us/album/the-1/1528112358?i=1528112361", > "albumId": "1528112358", > "albumName": null, > "releaseYear": null, > "artists": [], > "artistName": "Taylor Swift", > "durationMs": 210252, > "trackNumber": 1, > "discNumber": 1, > "composer": "Taylor Swift & Aaron Dessner", > "previewUrl": "https://audio-ssl.itunes.apple.com/itunes-assets/AudioPreview221/v4/c2/c2/3f/c2c23fa1-1219-cf9e-25d3-e71b30f53114/mzaf_7605028936051965013.plus.aac.ep.m4a", > "isExplicit": true, > "isPopular": true, > "artworkUrl": null > } > ], > "otherVersions": [ > { > "kind": "album", > "id": "1528111535", > "name": "folklore (deluxe version)", > "headline": null, > "subtitle": "17 songs", > "url": "https://music.apple.com/us/album/folklore-deluxe-version/1528111535", > "artworkUrl": "https://is1-ssl.mzstatic.com/image/thumb/Music124/v4/8c/ef/c2/8cefc23a-61b7-05ff-b52a-bb1e4922087c/20UMGIM64216.rgb.jpg/3000x3000bb.jpg", > "isExplicit": false > } > ], > "musicVideos": [ > { > "kind": "music-video", > "id": "1524878994", > "name": "cardigan", > "headline": null, > "subtitle": "Taylor Swift", > "url": "https://music.apple.com/us/music-video/cardigan/1524878994", > "artworkUrl": "https://is1-ssl.mzstatic.com/image/thumb/Video124/v4/26/4b/0a/264b0ac1-f92a-bc57-8af6-9a6abb20e752/20UMGIM64242.crop.jpg/1817x1072mv.jpg", > "isExplicit": false > } > ], > "moreByArtist": [ > { > "kind": "album", > "id": "1440933849", > "name": "reputation", > "headline": null, > "subtitle": "2017", > "url": "https://music.apple.com/us/album/reputation/1440933849", > "artworkUrl": "https://is1-ssl.mzstatic.com/image/thumb/Music221/v4/eb/e6/06/ebe606da-e00f-82d3-47f3-b79904eed541/17UM1IM24651.rgb.jpg/6000x6000bb.jpg", > "isExplicit": false > } > ], > "featuredOn": [ > { > "kind": "playlist", > "id": "pl.3950454ced8c45a3b0cc693c2a7db97b", > "name": "Taylor Swift Essentials", > "headline": null, > "subtitle": "Apple Music Pop", > "url": "https://music.apple.com/us/playlist/taylor-swift-essentials/pl.3950454ced8c45a3b0cc693c2a7db97b", > "artworkUrl": "https://is1-ssl.mzstatic.com/image/thumb/AMCArtistImages221/v4/6d/67/88/6d67888b-9e7f-53af-7853-0f91d6fd2332/ami_U003aidentity_U003a994af5c375f4c3aa96cd6ced4a70…", > "isExplicit": false > } > ], > "youMightAlsoLike": [ > { > "kind": "album", > "id": "1521724990", > "name": "minor", > "headline": null, > "subtitle": "Gracie Abrams", > "url": "https://music.apple.com/us/album/minor/1521724990", > "artworkUrl": "https://is1-ssl.mzstatic.com/image/thumb/Music115/v4/a2/54/c0/a254c01f-4e3c-0612-9e33-5d63d0128d70/20UMGIM54731.rgb.jpg/3000x3000bb.jpg", > "isExplicit": false > } > ], > "fetchedAt": "2026-11-10T16:02:27.635Z" > }, > "meta": { > "requestId": "req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f", > "creditsCharged": 1, > "creditsRemaining": 4999, > "cached": false > } > } > > Please help me write code in my preferred programming language to make this API call and handle the response appropriately. Include error handling and best practices. > ``` ## OpenAPI ````yaml /api-reference/openapi.json get /v1/apple-music/album openapi: 3.0.3 info: title: Scraperize API version: 1.0.0 description: >- Extract public data from social media platforms as clean JSON. Endpoints are split by platform and by what they return, e.g. `GET /v1/twitter/tweet`. ## Authentication Send your API key in the `x-api-key` header (or `Authorization: Bearer `). Create keys in your dashboard. ## Credits Each successful live scrape costs **1 credit**. Credits are prepaid and never expire. ## Caching Every endpoint accepts an optional `cache_max_age` (`1d`|`3d`|`7d`|`14d`|`30d`). A cache hit within that window is returned for **0 credits**. ## Responses Success returns `{ "data": …, "meta": { "requestId", … } }`. Errors return `{ "error": { "code", "message", "requestId" } }` with a matching HTTP status. `meta` on a scrape carries `creditsCharged`, `creditsRemaining`, `cached`, and (on a hit) `cachedAt`. ## Rate limits Requests are limited per team per minute; over the limit returns `429` with a `Retry-After` header. servers: - url: https://api.scraperize.com description: Production security: - ApiKeyAuth: [] tags: - name: Twitter description: Twitter / X scraping endpoints - name: Facebook description: Facebook scraping endpoints - name: Linkme description: Linkme (link.me) scraping endpoints - name: Amazon description: Amazon (creator shop / storefront) scraping endpoints - name: Linkbio description: Linkbio (lnk.bio) scraping endpoints - name: Pillar description: Pillar (pillar.io) scraping endpoints - name: Komi description: Komi (komi.io) scraping endpoints - name: Linktree description: Linktree (linktr.ee) scraping endpoints - name: Kick description: Kick (kick.com) scraping endpoints - name: Snapchat description: Snapchat (snapchat.com) scraping endpoints - name: Telegram description: Telegram (t.me) scraping endpoints - name: LinkedIn description: LinkedIn scraping endpoints - name: Twitch description: Twitch scraping endpoints - name: TikTok description: TikTok (tiktok.com) scraping endpoints - name: Instagram description: Instagram scraping endpoints - name: Lagos Life description: Lagos Life scraping endpoints - name: Bluesky description: Bluesky (bsky.app) scraping endpoints - name: Threads description: Threads (threads.com) scraping endpoints - name: Reddit description: Reddit (reddit.com) scraping endpoints - name: Rumble description: Rumble (rumble.com) scraping endpoints - name: SoundCloud description: SoundCloud (soundcloud.com) scraping endpoints - name: Kwai description: Kwai (kwai.com) scraping endpoints - name: Apple Music description: Apple Music (music.apple.com) scraping endpoints - name: Truth Social description: Truth Social (truthsocial.com) scraping endpoints - name: YouTube description: YouTube (youtube.com) scraping endpoints paths: /v1/apple-music/album: get: tags: - Apple Music summary: Album description: >- Returns an Apple Music album by id or link: name, artists, genres, release date, copyright, Apple's editorial notes, explicit flag, audio badges (Dolby Atmos, Lossless, Hi-Res Lossless, Apple Digital Master), price, track count and total length, cover, editorial and motion artwork, and every track — number, disc, name, length, credited artist, composer, a 30-second preview, explicit flag and Apple's "popular" mark — plus other versions, its music videos, more by the artist, playlists it's featured on and similar albums. Only publicly available data is returned. parameters: - name: id in: query required: false description: >- The album's Apple Music id (digits). Required unless `url` is given. Looked up in the US storefront. schema: type: string example: '1528112358' - name: url in: query required: false description: >- The album's music.apple.com link. Required unless `id` is given. The link's storefront (country) is used. schema: type: string example: https://music.apple.com/us/album/folklore-deluxe-version/1528112358 - name: cache_max_age in: query required: false description: >- Optional. Return a cached result if one this age or newer exists — served for **0 credits** with `meta.cached=true` and `meta.cachedAt`. Otherwise a fresh scrape runs (**1 credit**) and refreshes the cache. Omit to always scrape fresh. schema: type: string enum: - 1d - 3d - 7d - 14d - 30d example: 7d responses: '200': description: The album. content: application/json: schema: type: object properties: data: type: object meta: type: object description: >- requestId + credit/caching metadata (creditsCharged, creditsRemaining, cached, cachedAt). required: - data - meta example: data: id: '1528112358' name: folklore (deluxe version) url: >- https://music.apple.com/us/album/folklore-deluxe-version/1528112358 artists: - id: '159260351' name: Taylor Swift url: https://music.apple.com/us/artist/taylor-swift/159260351 genres: - Alternative - Music releaseDate: '2020-07-24' copyright: ℗ 2020 Taylor Swift description: >- A mere 11 months passed between the release of Lover and its surprise follow-up, but it feels like a lifetime. Written and recorded remotely during the first few months of the global pandemic, folklore finds the 30-year-old singer-songwriter teaming up with The National’s Aaron Dessner and longtime collaborator Jack Antonoff for a set of ruminative and relatively lo-fi bedroom pop that’s worlds away from its predecessor. When Swift opens “the 1”—a sly hybrid of plaintive piano and her naturally bouncy delivery—with “I’m doing good, I’m on some new shit,” you’d be forgiven for thinking it was another update from quarantine, or a comment on her broadening sensibilities. But Swift’s channeled her considerable energies into writing songs here that double as short stories and character studies, from Proustian flashbacks (“cardigan,” which bears shades of Lana Del Rey) to outcast widows (“the last great american dynasty”) and doomed relationships (“exile,” a heavy-hearted duet with Bon Iver’s Justin Vernon). It’s a work of great texture and imagination. “Your braids like a pattern/Love you to the moon and to Saturn,” she sings on “seven,” the tale of two friends plotting an escape. “Passed down like folk songs, the love lasts so long.” For a songwriter who has mined such rich detail from a life lived largely in public, it only makes sense that she’d eventually find inspiration in isolation. isExplicit: true trackCount: 17 durationMs: 4028392 artworkUrl: >- https://is1-ssl.mzstatic.com/image/thumb/Music115/v4/b5/80/dc/b580dca0-349d-036b-e09b-bd849f6affd8/20UMGIM64216.rgb.jpg/3000x3000bb.jpg editorialArtworkUrl: >- https://is1-ssl.mzstatic.com/image/thumb/Features114/v4/53/4c/b1/534cb156-9112-f7a0-83d7-6e3f2b090352/U0RTLU1TLVdXLVRheWxvcl9Td2lmdF9Gb2xrbG9yZS1BREFNX0lEPTE1MjQ4MDEyNjAucG5n.png/3840x3840bb.jpg motionArtworkUrl: >- https://mvod.itunes.apple.com/itunes-assets/HLSMusic125/v4/27/b4/5b/27b45bdd-aba1-8f0f-d9f8-17402222f215/P359221400_default.m3u8 audioBadges: dolbyAtmos: true dolbyAudio: false lossless: true hiResLossless: false digitalMaster: true offers: - type: buy price: 13.99 priceFormatted: $13.99 - type: subscription price: 0 priceFormatted: $0.00 tracks: - id: '1528112361' name: the 1 url: >- https://music.apple.com/us/album/the-1/1528112358?i=1528112361 albumId: '1528112358' albumName: null releaseYear: null artists: [] artistName: Taylor Swift durationMs: 210252 trackNumber: 1 discNumber: 1 composer: Taylor Swift & Aaron Dessner previewUrl: >- https://audio-ssl.itunes.apple.com/itunes-assets/AudioPreview221/v4/c2/c2/3f/c2c23fa1-1219-cf9e-25d3-e71b30f53114/mzaf_7605028936051965013.plus.aac.ep.m4a isExplicit: true isPopular: true artworkUrl: null - id: '1528112362' name: cardigan url: >- https://music.apple.com/us/album/cardigan/1528112358?i=1528112362 albumId: '1528112358' albumName: null releaseYear: null artists: [] artistName: Taylor Swift durationMs: 239560 trackNumber: 2 discNumber: 1 composer: Taylor Swift & Aaron Dessner previewUrl: >- https://audio-ssl.itunes.apple.com/itunes-assets/AudioPreview211/v4/dd/e7/4e/dde74e07-38b9-eae8-3457-e70325e561fd/mzaf_9976731997395798562.plus.aac.ep.m4a isExplicit: false isPopular: true artworkUrl: null - id: '1528112363' name: the last great american dynasty url: >- https://music.apple.com/us/album/the-last-great-american-dynasty/1528112358?i=1528112363 albumId: '1528112358' albumName: null releaseYear: null artists: [] artistName: Taylor Swift durationMs: 230999 trackNumber: 3 discNumber: 1 composer: Taylor Swift & Aaron Dessner previewUrl: >- https://audio-ssl.itunes.apple.com/itunes-assets/AudioPreview221/v4/8b/f6/7f/8bf67fda-a029-b865-935f-9ae9ce9f708e/mzaf_9542349838076651414.plus.aac.ep.m4a isExplicit: true isPopular: false artworkUrl: null otherVersions: - kind: album id: '1528111535' name: folklore (deluxe version) headline: null subtitle: 17 songs url: >- https://music.apple.com/us/album/folklore-deluxe-version/1528111535 artworkUrl: >- https://is1-ssl.mzstatic.com/image/thumb/Music124/v4/8c/ef/c2/8cefc23a-61b7-05ff-b52a-bb1e4922087c/20UMGIM64216.rgb.jpg/3000x3000bb.jpg isExplicit: false - kind: album id: '1524801260' name: folklore headline: null subtitle: 16 songs url: https://music.apple.com/us/album/folklore/1524801260 artworkUrl: >- https://is1-ssl.mzstatic.com/image/thumb/Music125/v4/ca/f3/67/caf367a5-2cf6-6b2e-a891-97dc57b19f08/20UMGIM64216.rgb.jpg/3000x3000bb.jpg isExplicit: true - kind: album id: '1524793738' name: folklore headline: null subtitle: 16 songs url: https://music.apple.com/us/album/folklore/1524793738 artworkUrl: >- https://is1-ssl.mzstatic.com/image/thumb/Music125/v4/7c/04/ba/7c04ba17-2ff8-21b3-0ac0-7d141f86e924/20UMGIM64216.rgb.jpg/3000x3000bb.jpg isExplicit: false musicVideos: - kind: music-video id: '1524878994' name: cardigan headline: null subtitle: Taylor Swift url: >- https://music.apple.com/us/music-video/cardigan/1524878994 artworkUrl: >- https://is1-ssl.mzstatic.com/image/thumb/Video124/v4/26/4b/0a/264b0ac1-f92a-bc57-8af6-9a6abb20e752/20UMGIM64242.crop.jpg/1817x1072mv.jpg isExplicit: false moreByArtist: - kind: album id: '1440933849' name: reputation headline: null subtitle: '2017' url: https://music.apple.com/us/album/reputation/1440933849 artworkUrl: >- https://is1-ssl.mzstatic.com/image/thumb/Music221/v4/eb/e6/06/ebe606da-e00f-82d3-47f3-b79904eed541/17UM1IM24651.rgb.jpg/6000x6000bb.jpg isExplicit: false - kind: album id: '1468058165' name: Lover headline: null subtitle: '2019' url: https://music.apple.com/us/album/lover/1468058165 artworkUrl: >- https://is1-ssl.mzstatic.com/image/thumb/Music125/v4/49/3d/ab/493dab54-f920-9043-6181-80993b8116c9/19UMGIM53909.rgb.jpg/3900x3900bb.jpg isExplicit: false - kind: album id: '1742057774' name: 'THE TORTURED POETS DEPARTMENT: THE ANTHOLOGY' headline: null subtitle: '2024' url: >- https://music.apple.com/us/album/the-tortured-poets-department-the-anthology/1742057774 artworkUrl: >- https://is1-ssl.mzstatic.com/image/thumb/Music221/v4/a4/86/59/a486593a-53c9-1c2a-5122-8f25339f7359/24UMGIM44778.rgb.jpg/3000x3000bb.jpg isExplicit: true featuredOn: - kind: playlist id: pl.3950454ced8c45a3b0cc693c2a7db97b name: Taylor Swift Essentials headline: null subtitle: Apple Music Pop url: >- https://music.apple.com/us/playlist/taylor-swift-essentials/pl.3950454ced8c45a3b0cc693c2a7db97b artworkUrl: >- https://is1-ssl.mzstatic.com/image/thumb/AMCArtistImages221/v4/6d/67/88/6d67888b-9e7f-53af-7853-0f91d6fd2332/ami_U003aidentity_U003a994af5c375f4c3aa96cd6ced4a700799-2026-09-25T04-00-05.358Z_cropped.png/1080x1080SC.FPESS05.jpg?l=en-US isExplicit: false - kind: playlist id: pl.57891bdd1bc840948374f1c4cbe9c840 name: Taylor Swift’s Eras Tour Set List headline: null subtitle: Apple Music Pop url: >- https://music.apple.com/us/playlist/taylor-swifts-eras-tour-set-list/pl.57891bdd1bc840948374f1c4cbe9c840 artworkUrl: >- https://is1-ssl.mzstatic.com/image/thumb/AMCArtistImages221/v4/6d/67/88/6d67888b-9e7f-53af-7853-0f91d6fd2332/ami_U003aidentity_U003a994af5c375f4c3aa96cd6ced4a700799-2026-09-25T04-00-05.358Z_cropped.png/1080x1080SC.FPSL03.jpg?l=en-US isExplicit: false - kind: playlist id: pl.3f890f86d4af450f9282446dfd4fdd4f name: 'Country Hits: 2020' headline: null subtitle: Apple Music Country url: >- https://music.apple.com/us/playlist/country-hits-2020/pl.3f890f86d4af450f9282446dfd4fdd4f artworkUrl: >- https://is1-ssl.mzstatic.com/image/thumb/Features122/v4/c8/ab/7d/c8ab7dda-ca60-956a-01d7-208a5761223f/f469be0f-faee-4f29-b8a4-4087f9307178.png/1080x1080SC.DN02.jpg?l=en-US isExplicit: false youMightAlsoLike: - kind: album id: '1521724990' name: minor headline: null subtitle: Gracie Abrams url: https://music.apple.com/us/album/minor/1521724990 artworkUrl: >- https://is1-ssl.mzstatic.com/image/thumb/Music115/v4/a2/54/c0/a254c01f-4e3c-0612-9e33-5d63d0128d70/20UMGIM54731.rgb.jpg/3000x3000bb.jpg isExplicit: false - kind: album id: '1736994915' name: GUTS (spilled) headline: null subtitle: Olivia Rodrigo url: https://music.apple.com/us/album/guts-spilled/1736994915 artworkUrl: >- https://is1-ssl.mzstatic.com/image/thumb/Music211/v4/5a/4c/6a/5a4c6aac-318a-b5a6-a481-15141d65fddc/24UMGIM30484.rgb.jpg/3000x3000bb.jpg isExplicit: true - kind: album id: '1572940891' name: Solar Power headline: null subtitle: Lorde url: https://music.apple.com/us/album/solar-power/1572940891 artworkUrl: >- https://is1-ssl.mzstatic.com/image/thumb/Music115/v4/46/9d/e2/469de216-6c4f-eb7f-7240-396f167bfe07/21UMGIM51680.rgb.jpg/3600x3600bb.jpg isExplicit: false fetchedAt: '2026-11-10T16:02:27.635Z' meta: requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f creditsCharged: 1 creditsRemaining: 4999 cached: false '401': description: Missing, invalid, or revoked API key. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: UNAUTHORIZED message: API key required — pass it in the `x-api-key` header. requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f '402': description: Not enough credits for this request. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: INSUFFICIENT_CREDITS message: >- This request costs 1 credit, but your balance is 0. Top up to continue. requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f '404': description: >- No album with that id in that storefront (it may not exist or not be available there). content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: NOT_FOUND message: >- The requested content was not found (it may not exist, be deleted, or be private). requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f '422': description: Invalid query parameters (`id` or `url` is required). content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: VALIDATION_ERROR message: Request validation failed requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f details: - path: url message: url is required '429': description: Over the per-minute rate limit — honour `Retry-After`. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: RATE_LIMITED message: >- Rate limit exceeded — max 100 requests per 60s. Retry in ~30s. requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f '503': description: >- Temporarily unavailable — retry after `Retry-After`. `error.code` tells you why: `UPSTREAM_BLOCKED` (the source blocked this request), `EXTRACTION_FAILED` (the source returned unexpected data), `PLATFORM_UNAVAILABLE` (the source is down), or `SERVICE_UNAVAILABLE` (we are at capacity). content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: UPSTREAM_BLOCKED message: >- The source is temporarily unavailable. Please try again shortly. requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f components: schemas: Error: type: object properties: error: type: object properties: code: type: string example: NOT_FOUND message: type: string example: The requested content was not found. requestId: type: string example: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f details: type: array items: type: object description: Present on validation errors. required: - code - message - requestId required: - error securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key description: >- Your API key. Send it in the `x-api-key` header (or `Authorization: Bearer `). Create and manage keys from your dashboard. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.