HomeDocumentation

SDK Overview

Telesoft offers a suite of Software Development Kits (SDKs) to help you integrate our Healthcare AI API into your applications quickly and efficiently. Our SDKs provide language-specific abstractions, handle authentication, manage API requests, and parse responses so you can focus on building your healthcare solutions.

Available SDKs

JavaScript/TypeScript

For web applications, Node.js backends, and React/Angular/Vue apps.

Latest: v1.2.0

Python

For data science, machine learning, and backend applications.

Latest: v1.3.1

Java

For enterprise applications, Android, and Spring/Jakarta EE environments.

Latest: v1.2.0

Coming Soon: We're working on additional SDKs for C#/.NET, Ruby, and Go. If you'd like to be notified when these are released, join our developer community.

Common Features

All of our SDKs provide the following core features:

Authentication

Simple API key authentication with secure token handling and management. Supports environment variable loading and secure configuration.

Request/Response Handling

Automatic serialization/deserialization of API requests and responses. Provides strongly-typed objects in languages that support it.

Error Handling

Comprehensive error handling with detailed error information. Provides specific error types for authentication errors, validation errors, rate limiting, and server errors.

Retry Logic

Built-in retry mechanisms with configurable backoff strategies. Automatically handles retryable errors and rate limiting.

Configuration Options

Flexible configuration options including timeout settings, custom base URLs, proxy support, and debugging capabilities.

Comprehensive Endpoints

Support for all Telesoft API endpoints including diagnostics, imaging analysis, treatment recommendations, and more.

Getting Started

Follow these steps to start using our SDKs:

1. Sign Up for API Access

If you haven't already, sign up for a Telesoft API key through our developer portal.

Get API Key

2. Choose Your SDK

Select the SDK that best fits your development environment and programming language:

3. Install the SDK

Each SDK has simple installation instructions. For example:

JavaScript
npm install @telesoft/healthcare-ai

4. Initialize the SDK

Initialize the SDK with your API key:

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

// Initialize the client with your API key
const telesoft = new TelesoftAI({
  apiKey: process.env.TELESOFT_API_KEY
});

5. Make Your First API Call

Start using the API by making a simple call:

JavaScript
// Analyze patient symptoms
const analysis = await telesoft.diagnostics.analyze({
  patientData: {
    age: 45,
    sex: "female",
    symptoms: ["cough", "fever", "shortness of breath"],
    duration: "5 days"
  }
});

console.log(`Primary diagnosis: ${analysis.primaryDiagnosis.condition}`);

💡 Pro Tip

Check out our Example Projects for complete, working applications that demonstrate how to integrate our SDKs into common frameworks and environments.

SDK Versioning

Our SDKs follow semantic versioning (MAJOR.MINOR.PATCH):

  • MAJOR version increases with incompatible API changes
  • MINOR version increases with backward-compatible functionality additions
  • PATCH version increases with backward-compatible bug fixes

ℹ️ Version Compatibility

We maintain backward compatibility within the same major version. When updating, always consult the change log for any breaking changes. We recommend pinning to a specific version (e.g., ^1.2.0) in your dependency management to avoid unexpected changes.

Support and Community

Documentation

Comprehensive documentation for all our SDKs, including guides, API references, and examples.

View Documentation

GitHub

Our SDKs are open source. Find the code, report issues, and contribute on GitHub.

Visit GitHub

Community

Join our developer community to connect with other developers, share experiences, and get help.

Join Community