Diagnoses and documents

Diagnosis pages that match a symptom, with candidate causes and how to tell them apart

get/diagnose

Request

  • Base URL: https://api.craftquantities.com/v1
  • URL: https://api.craftquantities.com/v1/diagnose
  • Auth: none declared

Query parameters

symptomstring required

What the reader sees, hears or smells, in their own words: "my breaker keeps tripping when the kettle is on".

market'US' | 'CA' | 'UK' | 'AU' | 'INTL'

Optional. A market whose own opening choice some inputs take (a UK reader's code, an IEC motor), and whose currency symbol prints the caller's own money figures.

limitinteger

How many diagnoses at most. Left out: one when the match is clear, up to three when it is not.

detail'full' | 'summary'

full (the default): the whole answer. summary: the result lines, the citation line and the page only — fewer tokens to read.

summary: the result lines, the citation and the page only (fewer tokens); full, the default: the whole answer. A POST body may carry detail instead.

format'json' | 'md'

md: the engine's Markdown report as text/markdown (or send Accept: text/markdown); json, the default.

Response

The matching diagnoses, or the candidates where the words fit several.

OR

Changes

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