Skip to main content
GET
/
file
/
detection
/
{sessionId}
Get royalty file detection status
curl --request GET \
  --url https://api.royalti.io/file/detection/{sessionId} \
  --header 'Authorization: Bearer <token>'
{
  "status": "success",
  "message": "Detection session retrieved successfully",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "status": "detected",
    "fileName": "spotify_2024-01.csv",
    "fileSize": 1048576,
    "detectedValues": {
      "source": "spotify",
      "period": "2024-01-01",
      "schema": {
        "artist": "string",
        "track": "string",
        "streams": "number",
        "revenue": "number"
      }
    },
    "confidence": {
      "source": 0.95,
      "period": 0.89,
      "schema": 0.92
    },
    "completedSteps": [
      "upload",
      "analysis",
      "pattern_matching"
    ],
    "expiresAt": "2024-01-16T12:00:00Z"
  }
}
This endpoint requires authentication. Include your Bearer token in the Authorization header.

​
Description

Get file detection status Retrieves the current status of a file detection session, including detected source, period, confidence scores, and processing status. Use this endpoint to poll for detection results after uploading a file with detection enabled.

​
Code Examples

const response = await fetch('https://api.royalti.io/file/detection/example-id', {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${token}`,
  },
});

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

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
sessionId
string<uuid>
required

The detection session ID returned from file upload

Response

Detection status retrieved successfully

​
status
enum<string>
Available options:
success
​
message
string
​
data
object