Retry a failed royalty file

curl --request POST \
  --url https://api.royalti.io/file/{fileId}/retry \
  --header 'Authorization: Bearer <token>'

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.royalti.io/file/{fileId}/retry', 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/{fileId}/retry",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.royalti.io/file/{fileId}/retry"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.royalti.io/file/{fileId}/retry")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "status": "success",
  "message": "File re-queued for processing",
  "data": {
    "fileId": "file-uuid-123",
    "jobId": "4821",
    "status": "processing",
    "retryCount": 1
  }
}

POST

file

{fileId}

retry

Retry a failed royalty file

curl --request POST \
  --url https://api.royalti.io/file/{fileId}/retry \
  --header 'Authorization: Bearer <token>'

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.royalti.io/file/{fileId}/retry', 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/{fileId}/retry",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.royalti.io/file/{fileId}/retry"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.royalti.io/file/{fileId}/retry")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "status": "success",
  "message": "File re-queued for processing",
  "data": {
    "fileId": "file-uuid-123",
    "jobId": "4821",
    "status": "processing",
    "retryCount": 1
  }
}

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

Description

same detection session, reconstructing the original job (source, accounting/sale period, schema, delimiter) rather than requiring a fresh upload. Guards before re-queueing:

The file must currently be failed or partial_failure (400 for any other status).
The file’s detection session must still exist (404 otherwise — see POST /file/{id}/redetect if it expired).
If a job for this session is already active, waiting, or delayed in one of the processing queues, the retry is refused (409) rather than double-queueing.
The original object must still be present in cloud storage; otherwise this returns 200 with data.requiresReupload: true instead of retrying, since there is nothing left to re-read.

On success, the file’s status is set back to processing and its prior error/progress metadata is cleared. Authorization: admin or higher (this route has no explicit RBAC entry, so it falls back to the platform default of admin or higher) plus the royaltyAccess feature flag.

Code Examples

const response = await fetch('https://api.royalti.io/file/example-id/retry', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${token}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({})
});

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

import requests

response = requests.post(
  'https://api.royalti.io/file/example-id/retry',
  headers={
    'Authorization': f'Bearer {token}'
  },
  json={}
)

data = response.json()
print(data)

curl -X POST https://api.royalti.io/file/example-id/retry \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

Authorizations

Authorization

string

header

required

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

Path Parameters

fileId

string<uuid>

required

The failed file to retry.

Response

File re-queued for processing, or (when the original object is no longer in storage) a requiresReupload notice instead of a retry

status

string

Example:

"success"

message

string

data

object

Show child attributes

​Description

​Code Examples

Authorizations

Path Parameters

Response

Description

Code Examples