Skip to content

Audicin for Apps API (1.0.0)

Audicin for Apps API Authentication (REQUIRED)

All Audicin for Apps API endpoints require the X-API-KEY header.

Example:

X-API-KEY: xxxxxxxxx

Common error responses:

  • 401 → Missing or invalid API key
  • 402 → Subscription inactive / expired
  • 403 → License missing or quota exceeded
  • 404 → Resource not found
Download OpenAPI description
b2b_portal_documentation.json
b2b_portal_documentation.yaml
Overview
URL
https://audicin.com
TEAM
developers@audicin.com
License
Proprietary License
Terms of Service
Languages
Servers
Generated server url
https://dev.api-b2b.audicin.com/api/v1

Artists

Fetch artist metadata

Operations

Licenses

Fetch license data

Operations

List tenant licenses

Request

Returns a paginated list of licenses owned by the authenticated tenant. Results can be filtered by song and license validity.

  • When onlyValidNow=true, only currently active licenses are returned.
  • When onlyValidNow=false, historical licenses are also included.

This endpoint is typically used to display license usage, quota tracking, and compliance status in the developer dashboard.

Security
api-key
Query
songIdstring
onlyValidNowboolean
Default false
pageinteger(int32)[ 0 .. 1000 ]
Default 0
sizeinteger(int32)[ 1 .. 1000 ]
Default 10
curl -i -X GET \
  'https://dev.api-b2b.audicin.com/api/v1/tenants/myLicenses?songId=string&onlyValidNow=false&page=0&size=10' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Paginated list of artists

Bodyapplication/json
contentArray of objects(ArtistTenantResponse)

Page content

numberinteger(int32)
Example: 0
sizeinteger(int32)
Example: 10
totalElementsinteger(int64)
Example: 42
totalPagesinteger(int32)
Example: 5
Response
application/json
{
  "content": [],
  "number": 0,
  "size": 10,
  "totalElements": 0,
  "totalPages": 0
}

Check license access for a song

Request

Checks whether the authenticated tenant has an active or historical license for a specific song. This endpoint is commonly used before attempting playback or streaming.

  • When onlyValid=true, only currently active licenses are considered.
  • When onlyValid=false, expired or revoked licenses may also be returned.
Security
api-key
Query
songIdstringrequired
onlyValidboolean
Default false
curl -i -X GET \
  'https://dev.api-b2b.audicin.com/api/v1/tenants/myLicenses/check-access?songId=string&onlyValid=false' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
idstring

License ULID

songobject(SongSummary)

Summary of a song (id, title, categories, duration)

statusstring

License status (ACTIVE, SUSPENDED, REVOKED, EXPIRED)

Enum"ACTIVE""SUSPENDED""REVOKED""EXPIRED"
validFromstring(date-time)

License valid from (inclusive)

validTostring(date-time)

License valid until (inclusive)

createdAtstring(date-time)

Creation timestamp

Response
application/json
{
  "id": "01HXZK9YF8A1B3C4D5E6F7G8H",
  "song": {
    "songId": "01HXZK9YF8A1B3C4D5E6F7G8H",
    "title": "Example Song",
    "categories": [],
    "seconds": 180
  },
  "status": "ACTIVE",
  "validFrom": "2025-01-01T00:00:00Z",
  "validTo": "2026-01-01T00:00:00Z",
  "createdAt": "2025-01-01T00:00:00Z"
}

Categories

Fetch category data

Operations

Streaming

Generate presigned URLs for audio previews and full audios

Operations

Songs

Fetch song data and metadata

Operations

Media

Fetch media data

Operations