Skip to main content
POST
/
work
/
{workId}
/
recordings
/
{assetId}
Link a work to a recording
curl --request POST \
  --url https://api.royalti.io/work/{workId}/recordings/{assetId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sharePercentage": 50,
  "isPrimary": true,
  "notes": "<string>"
}
'
import requests

url = "https://api.royalti.io/work/{workId}/recordings/{assetId}"

payload = {
"sharePercentage": 50,
"isPrimary": True,
"notes": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({sharePercentage: 50, isPrimary: true, notes: '<string>'})
};

fetch('https://api.royalti.io/work/{workId}/recordings/{assetId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.royalti.io/work/{workId}/recordings/{assetId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'sharePercentage' => 50,
'isPrimary' => true,
'notes' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.royalti.io/work/{workId}/recordings/{assetId}"

payload := strings.NewReader("{\n \"sharePercentage\": 50,\n \"isPrimary\": true,\n \"notes\": \"<string>\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.royalti.io/work/{workId}/recordings/{assetId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"sharePercentage\": 50,\n \"isPrimary\": true,\n \"notes\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.royalti.io/work/{workId}/recordings/{assetId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"sharePercentage\": 50,\n \"isPrimary\": true,\n \"notes\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "work": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "title": "<string>",
    "iswc": "<string>"
  },
  "recordings": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "title": "<string>",
      "isrc": "<string>",
      "displayArtist": "<string>",
      "type": "<string>",
      "linkInfo": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "sharePercentage": 123,
        "role": "<string>",
        "isPrimary": true,
        "notes": "<string>"
      }
    }
  ]
}
{
"status": "error",
"message": "<string>",
"code": "<string>",
"details": {}
}
{
"status": "error",
"message": "<string>",
"code": "<string>",
"details": {}
}
{
"status": "error",
"message": "<string>",
"code": "<string>",
"details": {}
}
{
"status": "error",
"message": "<string>",
"code": "<string>",
"details": {}
}
This endpoint requires authentication. Include your Bearer token in the Authorization header.

Description

POST /work//recordings/ Description: Creates a WorkRecording junction row linking a composition (CWRWork) to a master recording (Asset). 404 if either side doesn’t belong to the tenant; 400 if the link already exists. Response is the work’s full recordings list (not just the created link) so the FE can refresh in one round trip. Authorization:
  • Required role: admin or higher
Method: POST

Code Examples

const response = await fetch('https://api.royalti.io/work/{workId}/recordings/{assetId}', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${token}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "ref": "#/components/schemas/LinkRecordingRequest"
  })
});

const data = await response.json();
console.log(data);
import requests

response = requests.post(
  'https://api.royalti.io/work/{workId}/recordings/{assetId}',
  headers={
    'Authorization': f'Bearer {token}'
  },
  json={"ref":"#/components/schemas/LinkRecordingRequest"}
)

data = response.json()
print(data)
curl -X POST https://api.royalti.io/work/{workId}/recordings/{assetId} \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"ref":"#/components/schemas/LinkRecordingRequest"}'

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Path Parameters

workId
string<uuid>
required
assetId
string<uuid>
required

Body

application/json

All fields optional — defaults to sharePercentage=100, role=original, isPrimary=true. 400 if the work↔recording link already exists.

sharePercentage
number
Required range: 0 <= x <= 100
role
enum<string>
Available options:
original,
sample,
cover,
remix,
arrangement
isPrimary
boolean
notes
string

Response

Recording linked

Shape returned by link/unlink/list work-recordings endpoints.

work
object
recordings
object[]