limbo/Beat — API Reference¶
JSON:API documentation for the limbo/Beat platform. Each page below documents one API resource (attributes, relationships, filters, and CRUD support) or a guide.
All endpoints live under /api/v1 and require a Bearer token. Start with Authentication, then follow the Tutorial for an end-to-end delivery flow.
Getting started¶
| Doc | Description |
|---|---|
| Authentication | How to obtain and send the Bearer token required by every /api/v1 endpoint. |
| Tutorial | End-to-end walkthrough of distributing a product through the limbo/Beat API. |
Release entities¶
The core objects you create to build and ship a release.
| Resource | Description |
|---|---|
| Product | Central release entity (album, single, EP, etc.). |
| Track | Individual recording within a product. |
| Record | FLAC master audio file linked to a track, plus its technical metadata. |
| Offer | How a product is presented to DSPs: dates, subgenres, usage flags and delivery targets. |
| TrackOffer | Per-track override inside an offer (e.g. opt a track out of fingerprint scanning). |
| AtmosImportTask | Imports a Dolby Atmos audio file from a URL and links it to a track. |
Artists & credits¶
| Resource | Description |
|---|---|
| Artist | Musical artist linked to products and tracks, with per-DSP identification data. |
| ArtistDspIdentification | Maps an artist to their platform-specific ID and profile URL on a given DSP. |
Catalog & organization¶
The label/company/group hierarchy your catalog belongs to. Mostly read-only.
| Resource | Description |
|---|---|
| Label | Releasing entity for products; carries usage-rights metadata. |
| Company | Record-label company that groups labels and products. Read-only. |
| Group | Organizational entity containing users and companies. Read-only. |
| Distributor | Distribution entity belonging to a group. Read-only. |
| DistributorProductSubGenre | Distributor-specific subgenre used on offers. Read-only. |
Distribution & delivery¶
Rights, delivery channels and the resources that send releases to DSPs.
| Resource | Description |
|---|---|
| Right | Controls which DSPs may distribute a product, optionally scoped to territories/continents. |
| SendTask | Sends a product to a specific DSP. |
| DspUploadIdentification | Delivery channel pairing a DSP with a distributor (DDEX sender identity). Read-only. |
| Dsp | Digital Service Provider (Spotify, Apple Music, Amazon, etc.). Read-only. |
Reference data¶
Read-only resources: lookup tables for tagging and scoping releases, plus the authenticated account.
| Resource | Description |
|---|---|
| ProductType | Classifies a product (Album, Single, EP, etc.). Read-only. |
| Language | Normalized identifier used to tag products and tracks. Read-only. |
| Continent | Groups distribution territories to scope rights and deals. Read-only. |
| Territory | Country/region used in distribution deals and release targeting. Read-only. |
| User | Authenticated account, scoped to the user's group. Read-only. |