healthcare

Search NUCC taxonomy by free text

Search for taxonomy rows matching a free-text query. Three modes: 'exact' (fast, narrow — case-insensitive equality), 'fuzzy' (rapidfuzz token_set_ratio over display_name, sub-millisecond, works without the embed server), 'semantic' (vector KNN via the local embedding service, best quality). Semantic mode degrades to fuzzy when the embed server is unavailable; the response's 'mode_used' field reflects what actually ran. Returns up to 'limit' ranked candidates with per-result 'score' in [0,1].

post/v1/healthcare/taxonomy/search

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/healthcare/taxonomy/search
  • 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

Free-text query, e.g. 'family medicine'.

modestring

Search mode: 'exact' (case-insensitive equality on display_name or code), 'fuzzy' (rapidfuzz over display_name), or 'semantic' (vector KNN via the embedding service). Semantic mode falls back to fuzzy when the embed server is unavailable.

limitinteger
fieldsstring[] nullable

Optional list of fields to return per row. Defaults to all. Valid fields: code, grouping, classification, specialization, definition, notes, display_name, section. The 'code' field is always returned.

include_traceboolean

Response

Successful Response

statusstring
confidencenumber required

Changes

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