API Reference

The Telesoft Healthcare AI API provides a comprehensive set of endpoints for integrating medical AI capabilities into your healthcare applications. This reference documentation details all available endpoints, request parameters, response formats, and example usage.

API Overview

Base URL

https://api.telesoft.us/v2

Request Format

The API accepts requests with JSON payloads and returns JSON responses.

// Example request headers
Content-Type: application/json
Authorization: Bearer ts_live_xxxxxxxxxxxxxxxxxxxxxxxxxxx
X-Telesoft-Client: JavaScript/2.5.0

Response Format

All API responses follow a consistent format:

{
  "requestId": "req_7f9a2d7e8b3c",  // Unique identifier for the request
  "timestamp": "2025-05-06T12:34:56Z",  // ISO 8601 timestamp
  "data": { ... },  // Response data specific to the endpoint
  "meta": {  // Metadata about the response
    "processingTimeMs": 123,  // Processing time in milliseconds
    "version": "2.5.0"  // API version
  }
}

API Categories

The Telesoft API is organized into the following functional categories:

Diagnostics

Analyze medical data to generate diagnostic suggestions, confidence scores, and treatment recommendations.

View endpoints →

Patient Management

Create, retrieve, update, and manage patient profiles and their associated medical records.

View endpoints →

Medical Knowledge

Access Telesoft's medical knowledge base for conditions, treatments, medications, and guidelines.

View endpoints →

Healthcare Analytics

Generate insights from aggregated healthcare data for population health management.

View endpoints →

Medical Imaging

Analyze medical images to identify anomalies and assist with radiological diagnoses.

View endpoints →

System

API status, account management, and subscription-related endpoints.

View endpoints →

Versioning

The Telesoft API uses semantic versioning to manage changes and updates. The current version is v2.5.0.

Version Lifecycle

Major version changes (e.g., v1 → v2): May include breaking changes to the API, requiring updates to client applications.
Minor version changes (e.g., v2.4 → v2.5): Add new features or endpoints while maintaining backward compatibility.
Patch version changes (e.g., v2.5.0 → v2.5.1): Bug fixes and improvements with no API changes.

Version Support

Major API versions are supported for at least 12 months after a new major version is released. We recommend keeping your integration updated with the latest version to access new features and improvements.

Specifying Versions

You can specify the API version in your requests using the following methods:

URL Path: Include the major version in the URL path.
```
https://api.telesoft.us/v2/diagnostics/analyze
```
Request Header: Set the X-Telesoft-Version header for more specific versioning.
```
X-Telesoft-Version: 2.5.0
```

ℹ️ Version Migration

When upgrading between major versions, refer to our Migration Guides for detailed instructions on updating your integration.

Request Examples

Here are examples of how to make API requests using different programming languages:

cURL

curl -X POST https://api.telesoft.us/v2/diagnostics/analyze \
  -H "Authorization: Bearer ts_live_xxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "patientData": {
      "age": 45,
      "sex": "female",
      "symptoms": ["headache", "fever", "fatigue"],
      "vitalSigns": {
        "temperature": 101.2,
        "bloodPressure": { "systolic": 120, "diastolic": 80 },
        "heartRate": 88
      }
    },
    "options": {
      "includeConfidenceScores": true,
      "maxResults": 3
    }
  }'

JavaScript

import { TelesoftAI } from '@telesoft/healthcare-sdk';

// Initialize with your API key
const telesoft = new TelesoftAI({
  apiKey: 'ts_live_xxxxxxxxxxxxxxxxxxxxxxxxxxx',
  environment: 'production'
});

// Make the API request
async function analyzeMedicalData() {
  const result = await telesoft.diagnostics.analyze({
    patientData: {
      age: 45,
      sex: 'female',
      symptoms: ['headache', 'fever', 'fatigue'],
      vitalSigns: {
        temperature: 101.2,
        bloodPressure: { systolic: 120, diastolic: 80 },
        heartRate: 88
      }
    },
    options: {
      includeConfidenceScores: true,
      maxResults: 3
    }
  });
  
  console.log(result);
}

Python

from telesoft_healthcare import TelesoftAI

# Initialize with your API key
telesoft = TelesoftAI(api_key='ts_live_xxxxxxxxxxxxxxxxxxxxxxxxxxx')

# Make the API request
result = telesoft.diagnostics.analyze(
    patient_data={
        "age": 45,
        "sex": "female",
        "symptoms": ["headache", "fever", "fatigue"],
        "vital_signs": {
            "temperature": 101.2,
            "blood_pressure": {"systolic": 120, "diastolic": 80},
            "heart_rate": 88
        }
    },
    options={
        "include_confidence_scores": True,
        "max_results": 3
    }
)

print(result)

API Documentation Extensions

In addition to this reference documentation, we provide the following resources:

OpenAPI Specification

Download our OpenAPI 3.0 specification to generate client libraries and integrate with your API tooling.

Download OpenAPI Spec →

Postman Collection

Import our Postman collection to quickly test endpoints and explore the API functionality.

Download Postman Collection →

← Introduction API Endpoints →