Skip to content

Music

Get the client music search index

GET /api/music-search-index.json

Returns the compact, versioned public projection used for instant local music search. Conditional requests are supported with ETag.

Markdown · Authoritative OpenAPI

Request policy

Operation
getMusicSearchIndex
Access
anonymous
Automatic retries
None
Redirects
Returned to the caller without following
Request body limit
No request body
Pagination
No collection iterator

Parameters

No path or query parameters.

Request headers

  • API-Version (optional) — Header-based API version selection. Omit it, send an empty value, or send 1.0.0; surrounding whitespace is ignored.
  • Idempotency-Key (optional) — Accepted for clients that attach a key uniformly. GET, HEAD, and OPTIONS are already safe and intrinsically idempotent, so read responses are not stored in an idempotency replay cache.

Responses

200

Versioned music search index

Response headers
{
  "Content-Usage": {
    "description": "IETF AIPREF usage preferences for this public content",
    "schema": {
      "type": "string",
      "examples": [
        "train-ai=y, search=y"
      ]
    }
  },
  "Content-Signal": {
    "description": "Compatibility AI usage preferences for deployed crawlers",
    "schema": {
      "type": "string",
      "examples": [
        "ai-train=yes, search=yes, ai-input=yes"
      ]
    }
  },
  "API-Version": {
    "description": "Selected public REST contract version",
    "schema": {
      "type": "string",
      "enum": [
        "1.0.0"
      ]
    }
  },
  "RateLimit-Policy": {
    "description": "Public REST quota policy: 1000 Worker requests per 60 seconds for each source and Cloudflare location",
    "schema": {
      "type": "string"
    }
  },
  "RateLimit-Limit": {
    "description": "Compatibility form of the current public REST request limit",
    "schema": {
      "type": "integer",
      "enum": [
        1000
      ]
    }
  },
  "ETag": {
    "description": "Entity tag for conditional requests",
    "schema": {
      "type": "string"
    }
  },
  "Last-Modified": {
    "description": "Last modification date (HTTP IMF-fixdate)",
    "schema": {
      "type": "string",
      "pattern": "^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), [0-9]{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) [0-9]{4} [0-9]{2}:[0-9]{2}:[0-9]{2} GMT$",
      "examples": [
        "Sun, 06 Sep 2026 17:40:13 GMT"
      ]
    }
  },
  "Cache-Control": {
    "description": "Caching directives",
    "schema": {
      "type": "string"
    }
  }
}

application/json

MusicSearchIndexResponse

Schema details

version string required

Content-derived version that changes whenever the index data changes.

data MusicSearchIndexEntry[] required

Schema details

MusicSearchIndexEntry

Schema details

topics string[] required

Schema details

string

Allowed: "architecture" | "art" | "artificial intelligence" | "basketball" | "business" | "cities" | "creativity" | "culture" | "design" | "food" | "health" | "history" | "internet" | "leadership" | "music" | "nature" | "politics" | "product development" | "science" | "sports" | "technology" | "urbanism" | "work"

themes string[] required

Schema details

string

Allowed: "ambition" | "belonging" | "change" | "community" | "connection" | "craft" | "discovery" | "freedom" | "friendship" | "identity" | "loss" | "memory" | "power" | "resilience" | "transformation"

moods string[] required

Schema details

string

Allowed: "atmospheric" | "calm" | "contemplative" | "energizing" | "hopeful" | "intimate" | "joyful" | "melancholic" | "playful" | "tense" | "warm"

tones string[] required

Schema details

string

Allowed: "analytical" | "earnest" | "humorous" | "irreverent" | "observational" | "optimistic" | "provocative" | "reflective" | "suspenseful"

styles string[] required

Schema details

string

Allowed: "cinematic" | "conversational" | "documentary" | "experimental" | "immersive" | "minimalist" | "narrative" | "practical" | "technical" | "visual"

pace string required

Allowed: "slow" | "measured" | "moderate" | "brisk" | "fast" | "varied"

id string required

canonicalId string required

itemPath string required

title string required

url string required (uri)

externalLinks object[] required

Schema details

object

Schema details

provider string required

Provider slug or hostname for an inferred canonical link.

relation string required

Allowed: "same-as" | "listen" | "purchase" | "appears-on" | "release-group" | "performance" | "official-page"

resourceType string required

Allowed: "recording" | "release" | "master" | "album" | "track" | "video" | "page"

url string required (uri)

externalId string

type string required

Allowed: "album" | "playlist" | "mix" | "track"

artist string required

album string required

albumCanonicalId string required

durationSeconds number required

isrc string required

discNumber number required

trackNumber number required

compositionCanonicalId string required

genres string[] required

Schema details

string

Allowed: "Afrobeats" | "Ambient" | "Blues" | "Classical" | "Country" | "Dance" | "Electronic" | "Folk" | "Funk" | "Hip-Hop" | "House" | "Jazz" | "Latin" | "Metal" | "Pop" | "Punk" | "R&B" | "Reggae" | "Rock" | "Soul"

releaseDate string required (date-time)

addedAt string required (date-time)

notes string required

search MusicSearchProjection required

Schema details

title string required

subtitle string required

keywords string required

body string required

path string required

sourceUrl string required

304

Not Modified

400

Unsupported API version

application/problem+json

ProblemDetails

Schema details

type string required (uri)

Problem type URI (see /problems/)

title string required

Short human-readable summary

status number required

HTTP status code

detail string required

Human-readable explanation

instance string (uri)

URI reference for this occurrence

412

Precondition Failed

429

Public REST request limit exceeded

Response headers
{
  "Retry-After": {
    "description": "Seconds before the request should be retried",
    "schema": {
      "type": "integer",
      "enum": [
        60
      ]
    }
  },
  "RateLimit": {
    "description": "Current quota state for the exhausted public-rest policy",
    "schema": {
      "type": "string"
    }
  },
  "Content-Usage": {
    "description": "IETF AIPREF usage preferences for this public content",
    "schema": {
      "type": "string",
      "examples": [
        "train-ai=y, search=y"
      ]
    }
  },
  "Content-Signal": {
    "description": "Compatibility AI usage preferences for deployed crawlers",
    "schema": {
      "type": "string",
      "examples": [
        "ai-train=yes, search=yes, ai-input=yes"
      ]
    }
  },
  "API-Version": {
    "description": "Selected public REST contract version",
    "schema": {
      "type": "string",
      "enum": [
        "1.0.0"
      ]
    }
  },
  "RateLimit-Policy": {
    "description": "Public REST quota policy: 1000 Worker requests per 60 seconds for each source and Cloudflare location",
    "schema": {
      "type": "string"
    }
  },
  "RateLimit-Limit": {
    "description": "Compatibility form of the current public REST request limit",
    "schema": {
      "type": "integer",
      "enum": [
        1000
      ]
    }
  }
}

application/problem+json

ProblemDetails

Schema details

type string required (uri)

Problem type URI (see /problems/)

title string required

Short human-readable summary

status number required

HTTP status code

detail string required

Human-readable explanation

instance string (uri)

URI reference for this occurrence

Examples

Examples use synthetic fixture values. Replace fixture identifiers with public IDs returned by the service. Request bodies and precise locations are transient; keep them out of logs.

curl

curl --fail-with-body --max-time 30 --max-filesize 16777216 --request GET 'https://irvinebroque.com/api/music-search-index.json' --header 'Accept: application/json'

TypeScript

import { PublicApi } from '@irvinebroque/public-api';
const api = new PublicApi();
const result = await api.music.searchIndex({});
console.log(result.status, result.headers.get('content-type')); // Keep transient capabilities in memory.

CLI

irvinebroque music search-index

The SDK preserves status, headers, and the server envelope. A 304 has no fresh body. Errors retain structured problem details; ordinary error messages omit response details. Responses are limited to 16 MiB and requests time out after 30 seconds by default.