Schemas
AiContribution
Declared level of generative AI contribution.
This is a single enum, reused with the same values on every resource that
can carry a declaration: a credit (roles), the static album cover
(products), an album motion art (asset-attachments) and a video (videos).
| Value | Meaning |
|---|---|
undeclared | No declaration has been made. Default value. |
none | Declared as containing no AI contribution. |
partly | AI contributed in part. |
entirely | Entirely generated by AI. |
undeclared and none are not the same thing: none is a positive
declaration that no AI was involved, undeclared means nobody has answered
the question yet.
Write semantics: omitting the attribute from a payload is a no-op and
leaves the current value untouched. Sending undeclared actively resets the
declaration. See
Declare AI contribution.
ProductResource
typeStandard relationships for Product resources
idProductRelationships
ProductListResponse
Array of resource objects (override with specific resource schema)
Related resources included in the response
ProductResponse
The primary resource object (override with specific resource schema)
Related resources included in the response
ProductCreateRequest
ProductUpdateRequest
SubmissionResource
typeidExtractResource
typeidTrackListResponse
Array of resource objects (override with specific resource schema)
Related resources included in the response
TrackResponse
The primary resource object (override with specific resource schema)
Related resources included in the response
TrackCreateRequest
TrackUpdateRequest
AppleArtistResource
typeidUnique identifier for the AppleArtist
AppleArtistCreateRequest
AppleArtistListResponse
Array of resource objects (override with specific resource schema)
Related resources included in the response
AppleArtistResponse
The primary resource object (override with specific resource schema)
Related resources included in the response
AssetAttachmentResource
typeStandard relationships for AssetAttachment resources
idAssetAttachmentRelationships
Polymorphic relationship to the attached object (e.g., Product)
AssetAttachmentListResponse
Array of resource objects (override with specific resource schema)
Related resources included in the response
AssetAttachmentResponse
The primary resource object (override with specific resource schema)
Related resources included in the response
AssetAttachmentCreateRequest
AssetAttachmentUpdateRequest
AvailabilityResource
typeStandard relationships for Availability resources
idAvailabilityRelationships
The Digital Service Provider this availability is for
The item (Artist, Product, or Track) this availability refers to
Optional territory-specific availability
AvailabilityListResponse
Array of resource objects (override with specific resource schema)
Related resources included in the response
AvailabilityResponse
The primary resource object (override with specific resource schema)
Related resources included in the response
ArtistRoleResource
typeidUnique hash identifier for the artist role
ArtistRoleListResponse
Array of resource objects (override with specific resource schema)
Related resources included in the response
ArtistListResponse
Array of resource objects (override with specific resource schema)
Related resources included in the response
ArtistResponse
The primary resource object (override with specific resource schema)
Related resources included in the response
ArtistCreateRequest
ArtistUpdateRequest
CompanyRelationships
The distributor this company belongs to
Labels owned by this company
Distribution rights managed by this company
Sales company contracts
CompanyListResponse
Array of resource objects (override with specific resource schema)
Related resources included in the response
CompanyResponse
The primary resource object (override with specific resource schema)
Related resources included in the response
CompanyCreateRequest
CompanyUpdateRequest
ContinentListResponse
Array of resource objects (override with specific resource schema)
Related resources included in the response
ContinentResponse
The primary resource object (override with specific resource schema)
Related resources included in the response
DistributorResource
typeDistributorListResponse
Array of resource objects (override with specific resource schema)
Related resources included in the response
DistributorResponse
The primary resource object (override with specific resource schema)
Related resources included in the response
DistributorCreateRequest
DistributorUpdateRequest
DspUploadIdentificationResource
typeidStandard relationships for DspUploadIdentification resources
DspStateResource
typeStandard relationships for DspState resources
idDspStateRelationships
DspStateListResponse
Array of resource objects (override with specific resource schema)
Related resources included in the response
DspStateResponse
The primary resource object (override with specific resource schema)
Related resources included in the response
DspStateCreateRequest
DspStateUpdateRequest
LanguageListResponse
Array of resource objects (override with specific resource schema)
Related resources included in the response
LanguageResponse
The primary resource object (override with specific resource schema)
Related resources included in the response
LocalizationResource
typeStandard relationships for Localization resources
idLocalizationRelationships
LocalizationListResponse
Array of resource objects (override with specific resource schema)
Related resources included in the response
LocalizationResponse
The primary resource object (override with specific resource schema)
Related resources included in the response
OfferResource
typeStandard relationships for Offer resources
idOfferRelationships
OfferListResponse
Array of resource objects (override with specific resource schema)
Related resources included in the response
OfferResponse
The primary resource object (override with specific resource schema)
Related resources included in the response
OfferCreateRequest
OfferUpdateRequest
PlaylistListResponse
Array of resource objects (override with specific resource schema)
Related resources included in the response
PlaylistResponse
The primary resource object (override with specific resource schema)
Related resources included in the response
ProductGenreResource
typeidProductGenreListResponse
Array of resource objects (override with specific resource schema)
Related resources included in the response
ProductGenreResponse
The primary resource object (override with specific resource schema)
Related resources included in the response
ProductTypeResource
typeidProductTypeListResponse
Array of resource objects (override with specific resource schema)
Related resources included in the response
ProductTypeResponse
The primary resource object (override with specific resource schema)
Related resources included in the response
QuotaResource
typeidQuota attributes (structure varies by quota type)
QuotaListResponse
Array of resource objects (override with specific resource schema)
Related resources included in the response
RecordResource
typeStandard relationships for Record resources
idRecordResponse
The primary resource object (override with specific resource schema)
Related resources included in the response
RecordListResponse
Array of resource objects (override with specific resource schema)
Related resources included in the response
RetailListResponse
Array of resource objects (override with specific resource schema)
Related resources included in the response
RetailResponse
The primary resource object (override with specific resource schema)
Related resources included in the response
RightResource
typeStandard relationships for Right resources
idRightRelationships
RightListResponse
Array of resource objects (override with specific resource schema)
Related resources included in the response
RightResponse
The primary resource object (override with specific resource schema)
Related resources included in the response
RightCreateRequest
RightUpdateRequest
RoleResource
typeidUnique hash identifier for the credit
Standard relationships for Role resources. All three are read-only: an existing credit cannot be re-pointed to another artist, track or product.
RoleRelationships
RoleListResponse
Array of resource objects (override with specific resource schema)
Related resources included in the response
RoleResponse
The primary resource object (override with specific resource schema)
Related resources included in the response
RoleUpdateRequest
SendTaskFactoryResource
typeStandard relationships for SendTaskFactory resources
idSendTaskFactoryRelationships
SendTaskFactoryListResponse
Array of resource objects (override with specific resource schema)
Related resources included in the response
SendTaskFactoryResponse
The primary resource object (override with specific resource schema)
Related resources included in the response
SendTaskFactoryCreateRequest
SendTaskResource
typeStandard relationships for SendTask resources
idSendTaskRelationships
SendTaskListResponse
Array of resource objects (override with specific resource schema)
Related resources included in the response
SendTaskResponse
The primary resource object (override with specific resource schema)
Related resources included in the response
SendTaskCreateRequest
SendTaskUpdateRequest
SpotifyArtistResource
typeidSpotifyArtistListResponse
Array of resource objects (override with specific resource schema)
Related resources included in the response
TagListResponse
Array of resource objects (override with specific resource schema)
Related resources included in the response
TagResponse
The primary resource object (override with specific resource schema)
Related resources included in the response
TerritoryListResponse
Array of resource objects (override with specific resource schema)
Related resources included in the response
TerritoryResponse
The primary resource object (override with specific resource schema)
Related resources included in the response
TrackOfferResource
typeStandard relationships for TrackOffer resources
idTrackOfferRelationships
TrackOfferListResponse
Array of resource objects (override with specific resource schema)
Related resources included in the response
TrackOfferResponse
The primary resource object (override with specific resource schema)
Related resources included in the response
TrackOfferCreateRequest
TrackOfferUpdateRequest
TrackVideoRelationships
TrackVideoListResponse
Array of resource objects (override with specific resource schema)
Related resources included in the response
TrackVideoResponse
The primary resource object (override with specific resource schema)
Related resources included in the response
TrackVideoCreateRequest
TrackVideoUpdateRequest
VideoRelationships
VideoListResponse
Array of resource objects (override with specific resource schema)
Related resources included in the response
VideoResponse
The primary resource object (override with specific resource schema)
Related resources included in the response
VideoCreateRequest
VideoUpdateRequest
ImportTaskRelationships
The resource this import task is attached to (Track, Video, or AssetAttachment)
ImportTaskResource
typeStandard relationships for ImportTask resources
idImportTaskCreateRequest
ImportTaskResponse
The primary resource object (override with specific resource schema)
Related resources included in the response
ImportTaskListResponse
Array of resource objects (override with specific resource schema)
Related resources included in the response
LabelCreateRequest
LabelUpdateRequest
SingleResourceResponse
dataThe primary resource object (override with specific resource schema)
Related resources included in the response
CollectionResponse
Array of resource objects (override with specific resource schema)
Related resources included in the response
PaginationMeta
record-countTotal number of records
page-countTotal number of pages
PaginationLinks
firstlastprevnextAccessRoleResource
typeidGroupResource
typeidUserResource
typeid