Cross-Arr compatibility parity map

GET

/compatibility/parity

curl --request GET \
  --url https://example.com/api/v1/compatibility/parity

• API v1

Returns the static cross-Arr entity/app support matrix and catalog of known semantic differences between Arr apps.

When databaseId is provided, also computes per-profile compatibility for that database’s quality profiles against each Arr app’s compatible quality names, attached as profiles.

Parameters

Query Parameters

databaseId

integer

PCD database ID to compute profile compatibility for

Responses

200

Compatibility parity map

Media typeapplication/json

object

entities

required

PCD config entities tracked by the Cross-Arr Parity Map

Array<string>

Allowed values: custom_formats quality_profiles quality_definitions delay_profiles metadata_profiles

apps

required

Arr app types represented as matrix columns

Array<string>

Allowed values: radarr sonarr lidarr

matrix

required

One row per parity entity, with a per-app support status column

Array<object>

object

entity

required

Parity entity this row describes

string

Allowed values: custom_formats quality_profiles quality_definitions delay_profiles metadata_profiles

label

required

Human-readable label for this entity row

string

radarr

required

Radarr support status for this entity

string

Allowed values: native shared unsupported

sonarr

required

Sonarr support status for this entity

string

Allowed values: native shared unsupported

lidarr

required

Lidarr support status for this entity

string

Allowed values: native shared unsupported

semanticDifferences

required

Curated catalog of same-API-shape/different-domain-semantics divergences

Array<object>

object

scope

required

Parity entity or workflow surface this semantic difference applies to

string

Allowed values: custom_formats quality_profiles quality_definitions delay_profiles metadata_profiles instances library releases rename upgrades

apps

required

Arr apps this entry applies to

Array<string>

Allowed values: radarr sonarr lidarr

summary

required

One-line summary of the semantic divergence

string

detail

required

Full explanation of why the divergence exists

string

suggestion

Suggested alternative or mitigation, when applicable

string

sourceRefs

required

Prose file/symbol anchors for drift audits, not imports

Array<string>

profiles

Per-profile Arr-type compatibility, when quality profile data is available

Array<object>

object

name

required

Quality profile name

string

compatibleArrTypes

required

Arr app types this profile’s enabled qualities are compatible with

Array<string>

Allowed values: radarr sonarr lidarr

basis

required

Algorithm basis used to compute this compatibility verdict

string

Allowed values: enabled-qualities

Example

{
  "entities": [
    "custom_formats"
  ],
  "apps": [
    "radarr"
  ],
  "matrix": [
    {
      "entity": "custom_formats",
      "radarr": "native",
      "sonarr": "native",
      "lidarr": "native"
    }
  ],
  "semanticDifferences": [
    {
      "scope": "custom_formats",
      "apps": [
        "radarr"
      ]
    }
  ],
  "profiles": [
    {
      "compatibleArrTypes": [
        "radarr"
      ],
      "basis": "enabled-qualities"
    }
  ]
}

400

Invalid databaseId

Media typeapplication/json

object

error

required

Error message

string

Example^generated

{
  "error": "example"
}

401

Authentication required

Media typeapplication/json

object

error

required

Error message

string

Example^generated

{
  "error": "example"
}

500

Failed to compute compatibility parity map

Media typeapplication/json

object

error

required

Error message

string

Example^generated

{
  "error": "example"
}