Introduction

Healthily offers an AI-driven symptom checker and assessment platform. It allows users to monitor health, manage 100s of conditions, track progress and much more.

The Healthily symptom checker can be integrated into third-party solutions by using our REST API.

The API allows developers to integrate Healthily's ground-breaking conversational AI technology into their own applications.

Endpoints

The consultation backbone is: Login → Get Terms → Accept Legal Terms → Initial → Chat (repeated, with Symptom Search and Step back where offered) → Report. Optional endpoints cover analytics, feedback, state restore, and articles.

For the full method-by-method documentation — headers, request/response schemas, and status codes — see the Endpoint Reference, or explore each endpoint interactively in this reference section.

How it works

The API uses JWT tokens that are ephemeral and narrowly scoped to a single consultation and cannot be renewed.

Login is required before any other API operation can take place. When you registered with Healthily, you received a set of credentials consisting of a partner_id, secret and api_key. Treat these as confidential credentials, store them in a secure vault and restrict access to a limited number of backend services and authorised employees.

Once you login, you will have access to the legal endpoints GET /terms and POST /terms. The terms must be first retrieved and then accepted. The response contains an upgraded JWT token, which needs to be then used for the rest of the API calls.

For as long as the login Authorization is valid, you can continue using the chat. From this point every API request will automatically be linked to a consultation based on the token, and you will not need to pass any discrete IDs to us.