Skip to content

Radio

replenish Radio Station

POST /api/recommendation/radio/station/{id}

Retained recommendation Worker adapter. Automatic retries are disabled. Maximum UTF-8 request body: 24576 bytes.

Markdown · Authoritative OpenAPI

Request policy

Operation
replenishRadioStation
Access
radio-capability
Automatic retries
None
Redirects
Returned to the caller without following
Request body limit
24576 UTF-8 bytes
Pagination
No collection iterator

Parameters

id string required

Request body

application/json

object required

Schema details

schemaVersion unknown required

stationSeed string required

affinities object[] required

Schema details

object

Schema details

canonicalId string required

weight number required

reasonCodes string[] required

Schema details

string

Allowed: "recording-id" | "recording-name" | "artist-id" | "artist-name" | "album-id" | "album-name" | "genre" | "semantic" | "avoid"

votes object[] required

Schema details

object

Schema details

canonicalId string required

direction string required

Allowed: "more" | "less"

evidence string

Allowed: "explicit" | "completion" | "early-skip"

weight number

hardExclusions string[] required

Schema details

string

recentCanonicalIds string[] required

Schema details

string

intent string

genre string

context object

Schema details

timeOfDay string required

Allowed: "dawn" | "morning" | "afternoon" | "evening" | "night"

weatherKind string required

Allowed: "clear" | "cloudy" | "fog" | "drizzle" | "rain" | "snow" | "storm" | "unknown"

calendarKind string required

Allowed: "weekday" | "weekend" | "holiday"

daylight string

Allowed: "day" | "night" | "unknown"

season string

Allowed: "spring" | "summer" | "autumn" | "winter" | "unknown"

continuation object

Schema details

version unknown required

played object[] required

Schema details

object

Schema details

canonicalId string required

playedAt number required

queuedCanonicalIds string[] required

Schema details

string

position number required

limit number

Responses

200

Successful response

application/json

object

Schema details

schemaVersion unknown required

status string required

Allowed: "ready" | "empty" | "degraded"

profile object required

Schema details

seedCount number required

positiveVoteCount number required

negativeVoteCount number required

intentApplied boolean required

contextApplied boolean required

tracks object[] required

Schema details

object

Schema details

canonicalId string required

title string required

artist string required

genres string[] required

Schema details

string

spotifyUri string required

spotifyUrl string required (uri)

itemPath string required

reasonCodes string[] required

Schema details

string

Allowed: "profile-affinity" | "session-more" | "intent-adjacent" | "context-adjacent" | "musical-neighbor" | "exploration" | "editorial-core" | "editorial-recurrent" | "underplayed" | "contrast" | "discovery" | "transition-fit"

programming object

Schema details

role string required

Allowed: "core-opener" | "adjacent" | "deep-cut" | "listener-affinity" | "contrast" | "discovery"

rotation string required

Allowed: "core" | "recurrent" | "deep-cut" | "discovery"

diagnostics object required

Schema details

profileVersion string required

candidateCount number required

eligibleCount number required

fallback boolean required

cooldownRelaxed boolean

contextSignals string[]

Schema details

string

Allowed: "time-of-day" | "weather" | "daylight" | "season"

clock string

slots object[]

Schema details

object

Schema details

position number required

role string required

Allowed: "core-opener" | "adjacent" | "deep-cut" | "listener-affinity" | "contrast" | "discovery"

candidateCount number required

shortlistSize number required

selectedRank number required

Schema details

number

unknown

relaxedRules string[] required

Schema details

string

Allowed: "artist-separation" | "sound-family-separation" | "album-separation"

400

Request failed

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

401

Request failed

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

403

Request failed

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

413

Request failed

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

429

Request failed

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

502

Request failed

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

503

Request failed

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 POST 'https://irvinebroque.com/api/recommendation/radio/station/fixture' --header 'Accept: application/json' --header "Authorization: Bearer $RADIO_CAPABILITY" --header 'Content-Type: application/json' --data-binary @request.json

TypeScript

import { PublicApi } from '@irvinebroque/public-api';
const api = new PublicApi();
const capability = 'replace-with-scoped-radio-capability';
const result = await api.radio.replenish({
  "id": "fixture",
  "body": {
    "schemaVersion": "1",
    "stationSeed": "fixture",
    "affinities": [],
    "votes": [],
    "hardExclusions": [],
    "recentCanonicalIds": []
  }
}, { capability });
console.log(result.status, result.headers.get('content-type')); // Keep transient capabilities in memory.

CLI

irvinebroque radio replenish --id 'fixture' --body-file request.json --capability "$RADIO_CAPABILITY"

request.json

{
  "schemaVersion": "1",
  "stationSeed": "fixture",
  "affinities": [],
  "votes": [],
  "hardExclusions": [],
  "recentCanonicalIds": []
}

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.