Menu

Browse

ReleasesAlbumsBundlesChartsArtists

More

DiscoverSoftwareVideosPlaylistsEventsGroupsPricingBlog
Download
Back to Documentation

REST API Reference

v1

REST API with 227 endpoints across 35 resources

227
Total Endpoints
35
Resources
111
GET Endpoints
111
Write Endpoints

Configuration

Base URLhttps://api.audibase.com/api/v1
AuthenticationAuthorization: Bearer <firebase_id_token>

Quick Navigation

Auth(5)Me - Profile(5)Me - Media(3)Me - Cart(3)Me - Collections(3)Me - Conversations(6)Me - Downloads(1)Me - Events(1)Me - Feed(1)Me - Groups(1)Me - Notifications(4)Me - Playlists(3)Me - Products(4)Me - Promotions(2)Me - Purchases(2)Me - Seller(2)Me - Stats(1)Me - Storage(5)Me - Subscribers(2)Me - Subscriptions(6)Users(21)Media(14)AI(4)Checkout(11)Collections(19)Config(1)Creator Tiers(5)Events(13)Feed(10)Groups(18)Playlists(17)Products(22)Promotions(8)Radio(2)Search(2)
GETRead data
POSTCreate resource
PUTReplace resource
PATCHUpdate resource
DELETEDelete resource

Auth

5 endpoints
POST
/auth/logoutAuth

Logout from all devices

POST
/auth/refresh

Refresh access token

GET
/auth/status

Get authentication status

DELETE
/auth/tokensAuth

Revoke all tokens

POST
/auth/verify

Verify access token

Me - Profile

5 endpoints
GET
/meAuth

Get current user

POST
/meAuth

Ensure user exists

PATCH
/meAuth

Update profile

POST
/me/onboardingAuth

Complete user onboarding

PUT
/me/usernameAuth

Change username

Me - Media

3 endpoints
GET
/me/mediaAuth

Get user media

Query params:pagelimitvisibilityinclude
GET
/me/media/bookmarksAuth

Get bookmarked media

Query params:pagelimit
GET
/me/media/likesAuth

Get liked media

Query params:pagelimit

Me - Cart

3 endpoints
GET
/me/cartAuth

Get shopping cart

POST
/me/cartAuth

Add to cart

DELETE
/me/cartAuth

Remove from cart

Query params:releaseIdclearAll

Me - Collections

3 endpoints
GET
/me/collectionsAuth

Get user collections

Query params:pagelimittypevisibility
GET
/me/collections/bookmarksAuth

Get bookmarked collections

Query params:pagelimit
GET
/me/collections/likesAuth

Get liked collections

Query params:pagelimit

Me - Conversations

6 endpoints
GET
/me/conversationsAuth

Get conversations

Query params:pagelimit
POST
/me/conversationsAuth

Start conversation

GET
/me/conversations/:conversationIdAuth

Get conversation messages

Query params:pagelimit
POST
/me/conversations/:conversationIdAuth

Send message

DELETE
/me/conversations/:conversationIdAuth

Delete conversation

PATCH
/me/conversations/:conversationId/readAuth

Mark as read

Me - Downloads

1 endpoint
GET
/me/downloadsAuth

Get downloadable content

Query params:pagelimit

Me - Events

1 endpoint
GET
/me/eventsAuth

Get user events

Query params:pagelimitstatus

Me - Feed

1 endpoint
GET
/me/feedAuth

Get personalized feed

Query params:pagelimit

Me - Groups

1 endpoint
GET
/me/groupsAuth

Get user groups

Query params:pagelimitfilter

Me - Notifications

4 endpoints
GET
/me/notificationsAuth

Get notifications

Query params:pagelimitunread
POST
/me/notificationsAuth

Mark notifications read

GET
/me/notifications/unread-countAuth

Get unread count

GET
/notifications/stream

Notifications SSE stream

Query params:token

Me - Playlists

3 endpoints
GET
/me/playlistsAuth

Get user playlists

Query params:pagelimit
GET
/me/playlists/bookmarksAuth

Get bookmarked playlists

Query params:pagelimit
GET
/me/playlists/likesAuth

Get liked playlists

Query params:pagelimit

Me - Products

4 endpoints
GET
/me/productsAuth

Get user products

Query params:pagelimitvisibilitytype
GET
/me/products/bookmarksAuth

Get bookmarked products

Query params:pagelimit
GET
/me/products/likesAuth

Get liked products

Query params:pagelimit
GET
/me/products/purchasesAuth

Get purchased products

Query params:pagelimit

Me - Promotions

2 endpoints
GET
/me/promotionsAuth

Get user promotions

Query params:pagelimitstatus
GET
/me/promotions/statsAuth

Get promotion stats

Me - Purchases

2 endpoints
GET
/me/purchasesAuth

Get user purchases

Query params:pagelimittypestatus
GET
/me/purchases/:idAuth

Get purchase details

Me - Seller

2 endpoints
GET
/me/seller/transactionsAuth

Get seller transactions and stats

GET
/me/seller/transactions/summaryAuth

Get transaction summary

Query params:period

Me - Stats

1 endpoint
GET
/me/statsAuth

Get user stats

Me - Storage

5 endpoints
GET
/me/storageAuth

Get storage usage

POST
/me/storage/deleteAuth

Delete file or folder

POST
/me/storage/downloadAuth

Get download URL

POST
/me/storage/presignAuth

Get presigned upload URL

POST
/me/storage/recalculateAuth

Recalculate storage

Me - Subscribers

2 endpoints
GET
/me/subscribersAuth

Get subscribers

Query params:pagelimitstatus
GET
/me/subscribers/statsAuth

Get subscriber stats

Me - Subscriptions

6 endpoints
GET
/me/subscriptionsAuth

Get subscription status

GET
/me/subscriptions/contentAuth

Get subscribed content

Query params:typecreatorId
GET
/me/subscriptions/historyAuth

Get subscription history

Query params:pagelimit
GET
/me/subscriptions/listAuth

List my creator subscriptions

Query params:pagelimitstatus
GET
/me/subscriptions/:creatorIdAuth

Check creator subscription

POST
/me/subscriptions/:creatorIdAuth

Cancel or reactivate a creator subscription

Users

21 endpoints
GET
/users

List users

Query params:pagelimitsortsearchqspecializations
POST
/users/check-username

Check username availability

GET
/users/search

Search users

Query params:pagelimitqquery
GET
/users/:username

Get user profile

GET
/users/:username/collections

Get user collections

Query params:pagelimitsorttype
GET
/users/:username/events

Get user events

Query params:pagelimittypeincludePast
GET
/users/:username/feed

Get user feed

Query params:pagelimit
GET
/users/:username/follow

Check follow status

POST
/users/:username/followAuth

Follow user

DELETE
/users/:username/followAuth

Unfollow user

GET
/users/:username/followers

Get user followers

Query params:pagelimit
GET
/users/:username/following

Get user following

Query params:pagelimit
GET
/users/:username/group-posts

Get user group posts

Query params:pagelimit
GET
/users/:username/groups

Get user groups

Query params:pagelimitsortcategory
GET
/users/:username/media

Get user media

Query params:pagelimitsorttypeinclude
GET
/users/:username/playlists

Get user playlists

Query params:pagelimitsort
GET
/users/:username/products

Get user products

Query params:pagelimitsorttype
GET
/users/:username/promotions

Get user promotions

Query params:pagelimitsection
GET
/users/:username/stats

Get user stats

GET
/users/:username/subscribers

Get creator subscribers

Query params:pagelimit
GET
/users/:username/tiers

Get creator tiers

Media

14 endpoints
GET
/media

List public media

Query params:pagelimitsorttypeinclude
POST
/mediaAuth

Create media

POST
/media/check-duplicateAuth

Check for duplicate media

GET
/media/:id

Get media by ID

Query params:include
PATCH
/media/:idAuth

Update media

DELETE
/media/:idAuth

Delete media

GET
/media/:id/comments

Get comments

Query params:pagelimit
POST
/media/:id/commentsAuth

Add comment

DELETE
/media/:id/comments/:commentIdAuth

Delete comment

GET
/media/:id/downloadAuth

Get media download URL

GET
/media/:id/likeAuth

Check if liked

POST
/media/:id/likeAuth

Like media

DELETE
/media/:id/likeAuth

Unlike media

POST
/media/:id/play

Track play

AI

4 endpoints
POST
/ai/chatAuth

Chat with DJ Vibes

GET
/ai/images/curatedAuth

Get curated Pexels images

Query params:pageperPage
GET
/ai/images/searchAuth

Search Pexels images

Query params:querypageperPage
POST
/ai/lyricsAuth

Generate song lyrics

Checkout

11 endpoints
POST
/checkout/albumAuth

Create album checkout

POST
/checkout/cartAuth

Create cart checkout

POST
/checkout/collectionAuth

Create collection checkout

POST
/checkout/plansAuth

Create platform plan checkout

POST
/checkout/productAuth

Create product checkout

POST
/checkout/promotionAuth

Create promotion checkout

POST
/checkout/releaseAuth

Create release checkout

POST
/checkout/softwareAuth

Create software checkout

POST
/checkout/subscriptionAuth

Create subscription checkout

POST
/checkout/ticketAuth

Create ticket checkout

POST
/checkout/tvAuth

Create TV show checkout

Collections

19 endpoints
GET
/collections

List public collections

Query params:pagelimitsorttype
POST
/collectionsAuth

Create collection

GET
/collections/type/:type

List collections by type

Query params:pagelimitsort
GET
/collections/:id

Get collection by ID or slug

Query params:includeProducts
PUT
/collections/:idAuth

Update collection

DELETE
/collections/:idAuth

Delete collection

POST
/collections/:id/bookmarkAuth

Bookmark collection

DELETE
/collections/:id/bookmarkAuth

Remove collection bookmark

GET
/collections/:id/comments

Get collection comments

Query params:pagelimit
POST
/collections/:id/commentsAuth

Add comment to collection

DELETE
/collections/:id/comments/:commentIdAuth

Delete collection comment

GET
/collections/:id/likeAuth

Check if liked

POST
/collections/:id/likeAuth

Like collection

DELETE
/collections/:id/likeAuth

Unlike collection

GET
/collections/:id/products

List products in collection

Query params:pagelimit
POST
/collections/:id/productsAuth

Add products to collection

DELETE
/collections/:id/products/:productIdAuth

Remove product from collection

GET
/collections/:id/purchase-statusAuth

Check purchase status

PUT
/collections/:id/reorderAuth

Reorder products in collection

Config

1 endpoint
GET
/config

Get app configuration

Creator Tiers

5 endpoints
GET
/creator-tiers

List creator tiers

Query params:creatorId
POST
/creator-tiersAuth

Create tier

GET
/creator-tiers/:tierId

Get tier by ID

PUT
/creator-tiers/:tierIdAuth

Update tier

DELETE
/creator-tiers/:tierIdAuth

Delete tier

Events

13 endpoints
GET
/events

List events

Query params:pagelimittypecityincludePast
POST
/eventsAuth

Create event

GET
/events/by-slug/:slug

Get event by slug

GET
/events/cities

List cities with events

GET
/events/type/:type

List events by type

Query params:pagelimit
GET
/events/:id

Get event by ID

PUT
/events/:idAuth

Update event

DELETE
/events/:idAuth

Delete event

GET
/events/:id/attendees

List event attendees

Query params:pagelimit
POST
/events/:id/attendeesAuth

Join event

DELETE
/events/:id/attendeesAuth

Leave event

POST
/events/:id/click

Track click

POST
/events/:id/impression

Track impression

Feed

10 endpoints
GET
/feed

Get global feed

Query params:pagelimit
POST
/feedAuth

Create new post

GET
/feed/:id

Get post by ID

PATCH
/feed/:idAuth

Update post

DELETE
/feed/:idAuth

Delete post

GET
/feed/:id/comments

Get post comments

Query params:pagelimit
POST
/feed/:id/commentsAuth

Add comment

DELETE
/feed/:id/comments/:commentIdAuth

Delete comment

POST
/feed/:id/likeAuth

Like post

DELETE
/feed/:id/likeAuth

Unlike post

Groups

18 endpoints
GET
/groups

List public groups

Query params:pagelimitsortcategory
POST
/groupsAuth

Create group

GET
/groups/search

Search groups

Query params:pagelimitqquery
GET
/groups/:id

Get group by ID

PATCH
/groups/:idAuth

Update group

DELETE
/groups/:idAuth

Delete group

GET
/groups/:id/members

Get group members

Query params:pagelimit
GET
/groups/:id/membershipAuth

Check membership status

POST
/groups/:id/membershipAuth

Join group

DELETE
/groups/:id/membershipAuth

Leave group

GET
/groups/:id/posts

Get group posts

Query params:pagelimit
POST
/groups/:id/postsAuth

Create group post

DELETE
/groups/:id/posts/:postIdAuth

Delete group post

GET
/groups/:id/posts/:postId/comments

Get post comments

Query params:pagelimit
POST
/groups/:id/posts/:postId/commentsAuth

Add comment to post

DELETE
/groups/:id/posts/:postId/comments/:commentIdAuth

Delete comment

POST
/groups/:id/posts/:postId/likeAuth

Like group post

DELETE
/groups/:id/posts/:postId/likeAuth

Unlike group post

Playlists

17 endpoints
GET
/playlists

List public playlists

Query params:pagelimitsort
POST
/playlistsAuth

Create playlist

GET
/playlists/:id

Get playlist by ID

PUT
/playlists/:idAuth

Update playlist

DELETE
/playlists/:idAuth

Delete playlist

POST
/playlists/:id/bookmarkAuth

Bookmark playlist

DELETE
/playlists/:id/bookmarkAuth

Remove bookmark from playlist

GET
/playlists/:id/comments

Get playlist comments

Query params:pagelimit
POST
/playlists/:id/commentsAuth

Add playlist comment

DELETE
/playlists/:id/comments/:commentIdAuth

Delete playlist comment

GET
/playlists/:id/likeAuth

Check playlist like status

POST
/playlists/:id/likeAuth

Like playlist

DELETE
/playlists/:id/likeAuth

Unlike playlist

GET
/playlists/:id/media

Get playlist media

POST
/playlists/:id/mediaAuth

Add media to playlist

DELETE
/playlists/:id/mediaAuth

Remove media from playlist

Query params:mediaId
POST
/playlists/:id/reorderAuth

Reorder playlist media

Products

22 endpoints
GET
/products

List public products

Query params:pagelimitsorttypetaxonomyPathpriceMinpriceMaxbpmMinbpmMaxkeyreleasedAfterreleasedBefore
POST
/productsAuth

Create product

GET
/products/:id/downloadAuth

Get product download URL

Query params:format
GET
/products/chart

Product chart

Query params:typedayslimit
POST
/products/check-duplicateAuth

Check for duplicate product

GET
/products/type/:type

List products by type

Query params:pagelimitsort
GET
/products/:id

Get product by ID or slug

PUT
/products/:idAuth

Update product

DELETE
/products/:idAuth

Delete product

GET
/products/:id/bookmarkAuth

Check bookmark status

POST
/products/:id/bookmarkAuth

Bookmark product

DELETE
/products/:id/bookmarkAuth

Remove bookmark

GET
/products/:id/comments

Get product comments

Query params:pagelimit
POST
/products/:id/commentsAuth

Add comment

DELETE
/products/:id/comments/:commentIdAuth

Delete comment

POST
/products/:id/comments/:commentId/likeAuth

Like comment

GET
/products/:id/likeAuth

Check if liked

POST
/products/:id/likeAuth

Like product

DELETE
/products/:id/likeAuth

Unlike product

POST
/products/:id/play

Record play

GET
/products/:id/rating

Slop or Drop tally

POST
/products/:id/rating

Call it slop or a drop

Promotions

8 endpoints
POST
/promotions/cleanupAuth

Clean up orphaned promotionBids

Query params:sectiondryRun
GET
/promotions/estimateAuth

Estimate promotion cost

Query params:sectiondays
POST
/promotions/positions/refreshAuth

Refresh promotion rankings

GET
/promotions/positions/:section

Get promotion positions

Query params:pagelimit
POST
/promotions/rerank/:sectionAuth

Rerank a section

POST
/promotions/syncAuth

Sync promotion status

GET
/promotions/:idAuth

Get promotion details

DELETE
/promotions/:idAuth

Cancel promotion

Radio

2 endpoints
GET
/radio

Get radio queue

Query params:modetrackIdtrackTypelimitbpmRangematchKeycategorybpmkey
GET
/radio/categories

Radio categories that have something to play

This documentation is automatically generated from the API source code.

Data is fetched from the live API and cached for 60 seconds.

Open API Tester