API v1

Reference.

A stable additive contract for catalog, discovery, markers, profiles, social activity, availability, events, and billing.

OpenAPI JSON
MethodPathPurposeCredits
POST/oauth/device/authorizeStart a customer-owned application connection0
POST/oauth/device/tokenPoll for the approved one-time bearer credential0
GET/api/v1/account/creditsGet wallet balance0
GET/api/v1/account/usageList usage receipts0
GET/api/v1/billing/ratesList the active credit tariff0
GET/api/v1/artwork/{sha256}/downloadDownload paid-account artwork for local caching1
POST/api/v1/catalog/searchSearch the normalized media catalog2 / 25
POST/api/v1/catalog/identifyIdentify a music track from a local acoustic fingerprint2 / 25
GET/api/v1/catalog/items/{cascacore_id}Get one catalog item1 / 25
GET/api/v1/catalog/items/{cascacore_id}/episodesList a show's canonical episodes1 / 25
POST/api/v1/catalog/candidates/{candidate_id}/selectSelect an ambiguous ebook or audiobook candidate1
GET/api/v1/catalog/collections/{cascacore_collection_id}Get one media collection1 / 25
POST/api/v1/catalog/resolveResolve an external media identity2 / 25 / 50 forced refresh
POST/api/v1/catalog/upsertSubmit catalog metadata1
GET/api/v1/discovery/listsList discovery feeds1
GET/api/v1/discovery/lists/{list_key}Get a discovery feed1 / 25
POST/api/v1/eventsRecord a playback or library event1
POST/api/v1/media/markers/lookupLook up start and end-credit markers1 / 25
POST/api/v1/media/markersSubmit or correct media markers10
POST/api/v1/profilesCreate a viewer profile1
GET/api/v1/profiles/{profile_id}Get a viewer profile1
PATCH/api/v1/profiles/{profile_id}Update profile identity1
PATCH/api/v1/profiles/{profile_id}/privacyUpdate profile privacy1
GET/api/v1/profiles/{profile_id}/reportGet a profile media report1
POST/api/v1/social/friend-requestsCreate a friend request1
GET/api/v1/social/friend-requestsList pending friend requests1
POST/api/v1/social/friend-requests/{request_id}/acceptAccept a friend request1
POST/api/v1/social/friend-requests/{request_id}/declineDecline a friend request1
POST/api/v1/social/friend-requests/{request_id}/cancelCancel an outgoing friend request1
POST/api/v1/social/blocksBlock a profile1
POST/api/v1/social/reportsReport a profile1
GET/api/v1/social/friendsList friends1
GET/api/v1/catalog/items/{cascacore_id}/social-summaryGet social context for a catalog item1
POST/api/v1/availability/observationsSubmit regional availability metadata1

Authentication headers

Authorization: Bearer CUSTOMER_ACCESS_TOKEN
X-Cascacore-Request-Id: STABLE_REQUEST_UUID

Credit-safe retries

Reuse the same request ID for the same logical operation. HTTP 402 means the customer's wallet needs credits; local playback and library access should continue.

Read the integration guide →