Skip to main content
POST
/
cwr
/
import
/
raw
Parse a raw CWR .txt file without persisting it
curl --request POST \
  --url https://api.royalti.io/cwr/import/raw \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form cwrFile='@example-file'
import requests

url = "https://api.royalti.io/cwr/import/raw"

files = { "cwrFile": ("example-file", open("example-file", "rb")) }
headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, files=files, headers=headers)

print(response.text)
const form = new FormData();
form.append('cwrFile', '<string>');

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

options.body = form;

fetch('https://api.royalti.io/cwr/import/raw', 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/cwr/import/raw",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"cwrFile\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: multipart/form-data"
  ],
]);

$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/cwr/import/raw"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"cwrFile\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")

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

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

	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/cwr/import/raw")
  .header("Authorization", "Bearer <token>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"cwrFile\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.royalti.io/cwr/import/raw")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"cwrFile\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body
{
  "status": "success",
  "message": "CWR file parsed successfully",
  "tenantId": 123,
  "data": {
    "metadata": {},
    "workCount": 123,
    "works": [
      {}
    ],
    "errors": [
      "<string>"
    ],
    "warnings": [
      "<string>"
    ],
    "success": true
  }
}
{
  "status": "error",
  "message": "<string>"
}
{
  "status": "error",
  "message": "<string>",
  "code": "<string>",
  "details": {}
}
This endpoint requires authentication. Include your Bearer token in the Authorization header.

​
Description

POST /cwr/import/raw Description: Accepts a single multipart file field named cwrFile (max 10 MB) containing a raw CWR .txt file (version auto-detected from the HDR record). Parses the file and returns the result — no rows are written to the database at this stage (persistence is a follow-on phase, WP-12b/WS-E). Accepted content types: text/plain, application/octet-stream, application/cwr. The file must begin with an HDR record. Authorization:
  • Required role: admin or higher
  • Requires an active publisher addon
Method: POST

​
Code Examples

const response = await fetch('https://api.royalti.io/cwr/import/raw', {
  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/cwr/import/raw',
  headers={
    'Authorization': f'Bearer {token}'
  },
  json={}
)

data = response.json()
print(data)

curl -X POST https://api.royalti.io/cwr/import/raw \
  -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}"

Body

multipart/form-data
​
cwrFile
file
required

Raw CWR .txt file, max 10 MB.

Response

File parsed (successfully or with recoverable errors — see data.success)

​
status
string
Example:

"success"

​
message
string
Example:

"CWR file parsed successfully"

​
tenantId
integer
​
data
object