Start Source Creator from Detection Session

curl --request POST \
  --url https://api.royalti.io/file/session/{sessionId}/start-source-creator \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.royalti.io/file/session/{sessionId}/start-source-creator"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

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

fetch('https://api.royalti.io/file/session/{sessionId}/start-source-creator', 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/session/{sessionId}/start-source-creator",
  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/session/{sessionId}/start-source-creator"

	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/session/{sessionId}/start-source-creator")

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": "Source Creator wizard started from detection session",
  "data": {
    "detectionSessionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "sourceCreatorSession": {
      "sessionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "headers": [
        "<string>"
      ],
      "sampleRows": [
        {}
      ],
      "fileInfo": {
        "format": "csv",
        "delimiter": "<string>",
        "headerRows": 123,
        "totalRows": 123
      },
      "existingMatch": {
        "sourceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "sourceName": "<string>",
        "confidence": 123
      },
      "matchingSources": [
        {
          "royaltySourceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "sourceName": "<string>",
          "matchScore": 123,
          "matchTier": "exact"
        }
      ],
      "suggestedName": "<string>",
      "periodDetection": {}
    }
  }
}

{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": [
      "<string>"
    ]
  }
}

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

{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": [
      "<string>"
    ]
  }
}

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

POST

file

session

{sessionId}

start-source-creator

Start Source Creator from Detection Session

curl --request POST \
  --url https://api.royalti.io/file/session/{sessionId}/start-source-creator \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.royalti.io/file/session/{sessionId}/start-source-creator"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

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

fetch('https://api.royalti.io/file/session/{sessionId}/start-source-creator', 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/session/{sessionId}/start-source-creator",
  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/session/{sessionId}/start-source-creator"

	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/session/{sessionId}/start-source-creator")

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": "Source Creator wizard started from detection session",
  "data": {
    "detectionSessionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "sourceCreatorSession": {
      "sessionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "headers": [
        "<string>"
      ],
      "sampleRows": [
        {}
      ],
      "fileInfo": {
        "format": "csv",
        "delimiter": "<string>",
        "headerRows": 123,
        "totalRows": 123
      },
      "existingMatch": {
        "sourceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "sourceName": "<string>",
        "confidence": 123
      },
      "matchingSources": [
        {
          "royaltySourceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "sourceName": "<string>",
          "matchScore": 123,
          "matchTier": "exact"
        }
      ],
      "suggestedName": "<string>",
      "periodDetection": {}
    }
  }
}

{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": [
      "<string>"
    ]
  }
}

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

{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": [
      "<string>"
    ]
  }
}

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

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

Description

This is used when the file detection flow returns low source confidence (sourceCreatorEligible: true in the upload-url response) and the user opts to create a new source rather than selecting an existing one. The endpoint reuses the parsedFileData (headers, sample rows) already stored on the detection session, so no file re-upload or re-parsing is needed. Flow:

POST /file/upload-url returns detectionResults.sourceCreatorEligible: true
Client calls this endpoint to start the Source Creator wizard
User completes the wizard (AI mapping → query generation → save)
Client calls POST /file/confirm-detection/{sessionId} with sourceCreatorSessionId
File proceeds to processing queue

Authorization:

Required role: user or higher

Code Examples

const response = await fetch('https://api.royalti.io/file/session/example-id/start-source-creator', {
  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/session/example-id/start-source-creator',
  headers={
    'Authorization': f'Bearer {token}'
  },
  json={}
)

data = response.json()
print(data)

curl -X POST https://api.royalti.io/file/session/example-id/start-source-creator \
  -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

sessionId

string<uuid>

required

File detection session ID

Response

Source Creator wizard started

status

string

Example:

"success"

message

string

Example:

"Source Creator wizard started from detection session"

data

object

Show child attributes

​Description

​Code Examples

Authorizations

Path Parameters

Response

Description

Code Examples