Skip to main content
POST
Match Persona

Authorizations

X-API-Key
string
header
required

Path Parameters

catalog_id
string<uuid>
required

Body

application/json

Request to match a persona against one catalog's entries.

persona
PersonaInputModel · object
required

The persona to match against this catalog.

Example:
settings
MatchSettings · object

Caller-controlled matching settings.

Response

Successful Response

Ranked catalog entries for one persona, with an explained score each.

interpretation
MatchInterpretation · object
required

What was read from the supplied persona.

matches
CatalogMatch · object[]
required

Ranked catalog entries that fit the persona.

settings_applied
MatchSettings · object
required

The settings this match was computed under.

strategy_version
string
required

Version of the scoring strategy that produced this match.

completeness
enum<string>
required

Whether this response is complete.

Available options:
complete,
truncated,
unavailable
brief_fingerprint
string
required

Stable identifier for this persona-and-settings pairing.

relevance_status
enum<string>
default:disabled

Full-context relevance assessment: applied, disabled, no_candidates, fallback after unavailability, skipped_sensitive to honor exclusions, or skipped_settings to preserve custom scoring preferences.

Available options:
disabled,
applied,
fallback,
skipped_sensitive,
skipped_settings,
no_candidates
judge_applied
boolean
default:false

Whether a borderline-match verification pass, selected server-side, was in effect for this response: either it ran and its answers were applied, or there was nothing borderline enough to need verifying. A match still returns normally, with this false, when no verification pass is configured, it only measures without changing results, or the selected backend is unavailable.