matching

Score similarity between two strings

Compare two strings using a configurable fuzzy matching strategy. Returns a score (0-100) and is_match flag (>=80). Inputs are case-insensitive and whitespace-trimmed. Tip: for organization or facility names, run /v1/names/org-name/clean on the inputs first so casing and punctuation don't depress scores. This is raw fuzzy string matching, not semantic — heavy abbreviations ('Univ' vs 'University', 'SLU') may still not match; lower the threshold or pre-expand abbreviations for those.

post/v1/matching/score

Request

  • Base URL: https://api.snipget.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.snipget.ai/v1/matching/score
  • Auth: none declared

Query parameters

include_receiptboolean

Set true to attach an execution receipt at meta.receipt — caller-verifiable sha256 hashes over the RFC 8785 (JCS) canonicalization of this call's as-received JSON body and its result (free, like include_trace). Reproduce with any JCS library: input_hash = sha256(jcs({"tool": <request path>, "args": <your body minus include_trace/include_receipt>})); result_hash = sha256(jcs(result)). For deterministic tools, same input on the same build reproduces result_hash.

Headers

authorizationstring nullable
X-API-Keystring nullable

Request body

astring required

First string to compare.

bstring required

Second string to compare.

strategystring

Similarity strategy: ratio (character-level), partial_ratio (best substring), token_sort_ratio (ignores word order), token_set_ratio (ignores order + duplicates, default).

include_traceboolean

Response

Successful Response

statusstring
confidencenumber required

Changes

No recorded changes to this operation across all 1 revision of this API.