Get File Upload URL

curl --request POST \
  --url https://api.royalti.io/file/upload-url \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "fileMetaData": {
    "originalname": "<string>",
    "mimetype": "<string>",
    "uploadType": "royalty",
    "size": 123
  },
  "royaltySource": "<string>",
  "accountingPeriod": "2023-12-25",
  "salePeriod": "2023-12-25",
  "autoDetect": true,
  "fileSample": "<string>",
  "autoProcessIfConfident": false,
  "forceManualConfirmation": false,
  "isZip": false
}
'

import requests

url = "https://api.royalti.io/file/upload-url"

payload = {
    "fileMetaData": {
        "originalname": "<string>",
        "mimetype": "<string>",
        "uploadType": "royalty",
        "size": 123
    },
    "royaltySource": "<string>",
    "accountingPeriod": "2023-12-25",
    "salePeriod": "2023-12-25",
    "autoDetect": True,
    "fileSample": "<string>",
    "autoProcessIfConfident": False,
    "forceManualConfirmation": False,
    "isZip": False
}
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({
    fileMetaData: {
      originalname: '<string>',
      mimetype: '<string>',
      uploadType: 'royalty',
      size: 123
    },
    royaltySource: '<string>',
    accountingPeriod: '2023-12-25',
    salePeriod: '2023-12-25',
    autoDetect: true,
    fileSample: '<string>',
    autoProcessIfConfident: false,
    forceManualConfirmation: false,
    isZip: false
  })
};

fetch('https://api.royalti.io/file/upload-url', 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/file/upload-url",
  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([
    'fileMetaData' => [
        'originalname' => '<string>',
        'mimetype' => '<string>',
        'uploadType' => 'royalty',
        'size' => 123
    ],
    'royaltySource' => '<string>',
    'accountingPeriod' => '2023-12-25',
    'salePeriod' => '2023-12-25',
    'autoDetect' => true,
    'fileSample' => '<string>',
    'autoProcessIfConfident' => false,
    'forceManualConfirmation' => false,
    'isZip' => false
  ]),
  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/file/upload-url"

	payload := strings.NewReader("{\n  \"fileMetaData\": {\n    \"originalname\": \"<string>\",\n    \"mimetype\": \"<string>\",\n    \"uploadType\": \"royalty\",\n    \"size\": 123\n  },\n  \"royaltySource\": \"<string>\",\n  \"accountingPeriod\": \"2023-12-25\",\n  \"salePeriod\": \"2023-12-25\",\n  \"autoDetect\": true,\n  \"fileSample\": \"<string>\",\n  \"autoProcessIfConfident\": false,\n  \"forceManualConfirmation\": false,\n  \"isZip\": false\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/file/upload-url")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"fileMetaData\": {\n    \"originalname\": \"<string>\",\n    \"mimetype\": \"<string>\",\n    \"uploadType\": \"royalty\",\n    \"size\": 123\n  },\n  \"royaltySource\": \"<string>\",\n  \"accountingPeriod\": \"2023-12-25\",\n  \"salePeriod\": \"2023-12-25\",\n  \"autoDetect\": true,\n  \"fileSample\": \"<string>\",\n  \"autoProcessIfConfident\": false,\n  \"forceManualConfirmation\": false,\n  \"isZip\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.royalti.io/file/upload-url")

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  \"fileMetaData\": {\n    \"originalname\": \"<string>\",\n    \"mimetype\": \"<string>\",\n    \"uploadType\": \"royalty\",\n    \"size\": 123\n  },\n  \"royaltySource\": \"<string>\",\n  \"accountingPeriod\": \"2023-12-25\",\n  \"salePeriod\": \"2023-12-25\",\n  \"autoDetect\": true,\n  \"fileSample\": \"<string>\",\n  \"autoProcessIfConfident\": false,\n  \"forceManualConfirmation\": false,\n  \"isZip\": false\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "message": "File upload record created, please utilise the signedUrl to upload the file",
  "data": {
    "fileId": "file-uuid-123",
    "signedUrl": "https://storage.googleapis.com/royalti-uploads/...",
    "detectionSessionId": "session-uuid-456",
    "requiresConfirmation": true
  }
}

{
  "status": "error",
  "message": "Invalid request parameters"
}

{
  "status": "error",
  "message": "Unauthorized"
}

{
  "status": "error",
  "message": "Internal server error"
}

POST

file

upload-url

Get File Upload URL

curl --request POST \
  --url https://api.royalti.io/file/upload-url \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "fileMetaData": {
    "originalname": "<string>",
    "mimetype": "<string>",
    "uploadType": "royalty",
    "size": 123
  },
  "royaltySource": "<string>",
  "accountingPeriod": "2023-12-25",
  "salePeriod": "2023-12-25",
  "autoDetect": true,
  "fileSample": "<string>",
  "autoProcessIfConfident": false,
  "forceManualConfirmation": false,
  "isZip": false
}
'

import requests

url = "https://api.royalti.io/file/upload-url"

payload = {
    "fileMetaData": {
        "originalname": "<string>",
        "mimetype": "<string>",
        "uploadType": "royalty",
        "size": 123
    },
    "royaltySource": "<string>",
    "accountingPeriod": "2023-12-25",
    "salePeriod": "2023-12-25",
    "autoDetect": True,
    "fileSample": "<string>",
    "autoProcessIfConfident": False,
    "forceManualConfirmation": False,
    "isZip": False
}
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({
    fileMetaData: {
      originalname: '<string>',
      mimetype: '<string>',
      uploadType: 'royalty',
      size: 123
    },
    royaltySource: '<string>',
    accountingPeriod: '2023-12-25',
    salePeriod: '2023-12-25',
    autoDetect: true,
    fileSample: '<string>',
    autoProcessIfConfident: false,
    forceManualConfirmation: false,
    isZip: false
  })
};

fetch('https://api.royalti.io/file/upload-url', 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/file/upload-url",
  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([
    'fileMetaData' => [
        'originalname' => '<string>',
        'mimetype' => '<string>',
        'uploadType' => 'royalty',
        'size' => 123
    ],
    'royaltySource' => '<string>',
    'accountingPeriod' => '2023-12-25',
    'salePeriod' => '2023-12-25',
    'autoDetect' => true,
    'fileSample' => '<string>',
    'autoProcessIfConfident' => false,
    'forceManualConfirmation' => false,
    'isZip' => false
  ]),
  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/file/upload-url"

	payload := strings.NewReader("{\n  \"fileMetaData\": {\n    \"originalname\": \"<string>\",\n    \"mimetype\": \"<string>\",\n    \"uploadType\": \"royalty\",\n    \"size\": 123\n  },\n  \"royaltySource\": \"<string>\",\n  \"accountingPeriod\": \"2023-12-25\",\n  \"salePeriod\": \"2023-12-25\",\n  \"autoDetect\": true,\n  \"fileSample\": \"<string>\",\n  \"autoProcessIfConfident\": false,\n  \"forceManualConfirmation\": false,\n  \"isZip\": false\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/file/upload-url")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"fileMetaData\": {\n    \"originalname\": \"<string>\",\n    \"mimetype\": \"<string>\",\n    \"uploadType\": \"royalty\",\n    \"size\": 123\n  },\n  \"royaltySource\": \"<string>\",\n  \"accountingPeriod\": \"2023-12-25\",\n  \"salePeriod\": \"2023-12-25\",\n  \"autoDetect\": true,\n  \"fileSample\": \"<string>\",\n  \"autoProcessIfConfident\": false,\n  \"forceManualConfirmation\": false,\n  \"isZip\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.royalti.io/file/upload-url")

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  \"fileMetaData\": {\n    \"originalname\": \"<string>\",\n    \"mimetype\": \"<string>\",\n    \"uploadType\": \"royalty\",\n    \"size\": 123\n  },\n  \"royaltySource\": \"<string>\",\n  \"accountingPeriod\": \"2023-12-25\",\n  \"salePeriod\": \"2023-12-25\",\n  \"autoDetect\": true,\n  \"fileSample\": \"<string>\",\n  \"autoProcessIfConfident\": false,\n  \"forceManualConfirmation\": false,\n  \"isZip\": false\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "message": "File upload record created, please utilise the signedUrl to upload the file",
  "data": {
    "fileId": "file-uuid-123",
    "signedUrl": "https://storage.googleapis.com/royalti-uploads/...",
    "detectionSessionId": "session-uuid-456",
    "requiresConfirmation": true
  }
}

{
  "status": "error",
  "message": "Invalid request parameters"
}

{
  "status": "error",
  "message": "Unauthorized"
}

{
  "status": "error",
  "message": "Internal server error"
}

This endpoint requires authentication. Include your Bearer token in the Authorization header.

Description

Auto-Detection Feature:

Set autoDetect: true to enable automatic source and period detection
Provide fileSample (base64-encoded) for pre-upload analysis
Use autoProcessIfConfident: true to skip manual confirmation when confidence is high
Set forceManualConfirmation: true to always require manual review

ZIP Files with Content Analysis:

For ZIP files, the client can extract one CSV from the archive and send it as fileSample
This enables full content-based source detection (header matching, schema detection)
If source confidence is low, sourceCreatorEligible will be set in the response
Without fileSample, ZIP files fall back to filename-only detection

Request Payload:

fileMetaData: Required - contains uploadType, originalname, mimetype, size
royaltySource: Optional if autoDetect is enabled
accountingPeriod: Optional if autoDetect is enabled
salePeriod: Optional sales period
autoDetect: Enable automatic source/period detection (default: true)
fileSample: Base64-encoded file sample for analysis (for ZIPs: extracted CSV content)
autoProcessIfConfident: Auto-process if detection confidence is high
forceManualConfirmation: Force manual review regardless of confidence
isZip: Indicates ZIP file containing multiple files

Authorization:

Required role: user or higher

Code Examples

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

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

import requests

response = requests.post(
  'https://api.royalti.io/file/upload-url',
  headers={
    'Authorization': f'Bearer {token}'
  },
  json={"ref":"#/components/schemas/UploadUrlRequest"}
)

data = response.json()
print(data)

curl -X POST https://api.royalti.io/file/upload-url \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"ref":"#/components/schemas/UploadUrlRequest"}'

Authorizations

Authorization

string

header

required

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

Body

application/json

fileMetaData

object

required

Show child attributes

royaltySource

string

Source of the royalty data (optional if autoDetect is true)

accountingPeriod

string<date>

The accounting period (YYYY-MM-DD) (optional if autoDetect is true)

salePeriod

string<date>

The sales period (YYYY-MM-DD)

autoDetect

boolean

default:true

Enable automatic detection of royalty source and period from file content

fileSample

string

Base64-encoded sample of file content for pre-upload analysis (optional)

autoProcessIfConfident

boolean

default:false

Automatically process file if detection confidence meets thresholds

forceManualConfirmation

boolean

default:false

Force manual confirmation even if auto-detection confidence is high

isZip

boolean

default:false

Indicates if the file is a ZIP archive containing multiple royalty files

Response

Pre-signed URL generated successfully

success

boolean

default:true

message

string

data

object

Show child attributes

​Description

​Code Examples

Authorizations

Body

Response

Description

Code Examples