API Documentation

HealixAI REST API

Build powerful healthcare applications with physician-reviewed AI

Getting Started

Base URL: https://api.healixai.com/v1

Authentication: Bearer token in Authorization header

Get API Key: app.healixai.com/dashboard/api-keys

POST

/v1/chat

Send a health question and receive an AI-powered, physician-reviewed response

Request Parameters

ParameterTypeRequiredDescription
messagestringYesThe health question
languagestringNoISO 639-1 code (default: en)
user_idstringNoTrack conversations by user
session_idstringNoContinue previous conversation

Example Request

curl -X POST https://api.healixai.com/v1/chat \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "message": "When should I see a doctor for knee pain?",
    "language": "en",
    "user_id": "patient_12345"
  }'

Example Response

{
  "response": "You should see a doctor for knee pain if...",
  "confidence": 0.95,
  "sources": [
    "American Academy of Orthopaedic Surgeons",
    "Mayo Clinic"
  ],
  "language": "en",
  "session_id": "sess_abc123"
}
GET

/v1/languages

Get list of supported languages (100+ languages)

curl -X GET https://api.healixai.com/v1/languages \
  -H "Authorization: Bearer YOUR_API_KEY"
GET

/v1/analytics

Get usage analytics and insights for your integration

curl -X GET https://api.healixai.com/v1/analytics?start_date=2024-01-01 \
  -H "Authorization: Bearer YOUR_API_KEY"

Returns: Total questions, most common topics, user satisfaction scores, language breakdown

SDK Examples

JavaScript / Node.js

const axios = require('axios');

async function askHealixAI(question) {
  try {
    const response = await axios.post('https://api.healixai.com/v1/chat', {
      message: question,
      language: 'en',
      user_id: 'patient_12345'
    }, {
      headers: {
        'Authorization': 'Bearer YOUR_API_KEY',
        'Content-Type': 'application/json'
      }
    });
    
    return response.data;
  } catch (error) {
    console.error('Error:', error);
  }
}

Python

import requests

def ask_healixai(question):
    response = requests.post(
        'https://api.healixai.com/v1/chat',
        headers={
            'Authorization': 'Bearer YOUR_API_KEY',
            'Content-Type': 'application/json'
        },
        json={
            'message': question,
            'language': 'en'
        }
    )
    return response.json()

API Features

Fast Response Times

Average response time under 500ms

HIPAA Compliant

Enterprise plans include BAA and HIPAA compliance

🌍

100+ Languages

Automatic language detection and translation

📊

Analytics & Insights

Track usage, popular topics, and user satisfaction

Ready to Start Building?

Get your API key and start integrating HealixAI today