matching

Find best matches for a query in a candidate list

Finds the top matches for a query string within a list of candidates. Returns ranked matches with scores. Useful for entity resolution: 'which of these known entities does this input most likely refer to?' 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. Billing: 1 cost unit per query per started block of 1,000 candidates (e.g. 1 query x 300 candidates = 1 unit; 1 query x 2,500 candidates = 3 units). The response's meta.cost_units shows the exact charge.

post/v1/matching/best-match

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/best-match
  • 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

querystring required

The string to find matches for.

candidatesstring[] required

List of candidate strings to match against.

strategystring

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

limitinteger

Max results to return.

score_cutoffnumber

Minimum score threshold (0.0–1.0).

include_traceboolean

Response

Successful Response

statusstring
confidencenumber required

Changes

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