What is the Smart Symptom Checker?

The Smart Symptom Checker is Healthily's AI-driven symptom assessment engine, covering hundreds of conditions. Through its REST API, you can run a full clinical-grade consultation inside your own product:

The user describes an initial symptom in free text ("earache, jaw clicks").
The engine interprets it, confirms which symptoms it recognised, and asks a series of targeted follow-up questions — clarifications, duration, health background, and diagnostic yes/no questions.
When enough evidence is gathered, it produces a report: a triage level (how urgent), the likely causes, conditions to rule out, recommended care services, and self-care articles.

Your application owns the entire user experience. The API returns typed questions — what to ask, the choices to offer, and selection constraints — and your client renders them however fits your product: chat bubbles, forms, wizards, or voice. You post back the user's answer, and the server returns the next question or the report.

The 60-second summary

A complete consultation is six endpoints:

POST /api/v1/login          partner_id + secret  →  access token
GET  /api/v1/terms          fetch legal content + version
POST /api/v1/terms          record consent       →  upgraded token
POST /api/v1/initial        age, gender, free-text symptom  →  first question
POST /api/v1/chat           answer {type, included, excluded}  →  next question   (repeat)
GET  /api/v1/report         when report_possible  →  triage + conditions + advice

Alongside the consultation itself, the API provides symptom search (a fast free-text endpoint that powers autocomplete when a symptom isn't recognised) and articles (the Healthily health library, for the medically reviewed content referenced by reports).

What you need

Partner credentials — a partner_id, secret, and api_key, issued per environment when you register. Don't have them yet? Sign up here.
A backend — authentication is at the partner level, so credentials must stay server-side, behind your own user authentication.
Familiarity with REST/JSON — no prior knowledge of the platform is assumed.

❗️
This API returns medical triage guidance. Always render the disclaimer messages the API provides, never suppress or re-rank triage outcomes, and surface emergency-level results prominently. See Regulatory Requirements.

Where to go next

If you want to...	Read
Understand the architecture, environments, and wire conventions	API Overview
Authenticate and understand the two-token flow	Partner Authentication
Follow the assessment lifecycle end to end	Conversation Flow
Look up any endpoint's schema and status codes	Endpoint Reference
Render questions and reports in your UI	Building a User Interface
See a complete consultation, request by request	Integration Walkthrough

Prefer to explore hands-on? The interactive API reference lets you try every endpoint in the browser, and the healthily-api-examples repository contains runnable end-to-end scenarios.