Skip to main content

Installation

Get Your API Key​

Before installing the SDK, you'll need an API key to activate it. The SDK is currently available to select partners — request API access to get one. Once you have your API key, you can proceed with installation.

Swift SDK​

Requirements​

  • iOS 17.0+
  • Xcode 15.0+
  • Swift 5.9+

macOS: The SDK has no iOS-specific dependencies and should be compatible with macOS 14.0+, but this hasn't been formally tested. If you're building for macOS, we'd love to hear how it goes — reach us at support@modelhealth.io

Swift Package Manager​

Add the Model Health SDK to your project using Swift Package Manager:

  1. In Xcode, select File > Add Package Dependencies...
  2. Enter the repository URL: https://github.com/model-health/model-health-swift
  3. Select version 0.9.1 (current beta release)
  4. Add ModelHealth to your target

Alternatively, add it to your Package.swift:

dependencies: [
  .package(url: "https://github.com/model-health/model-health-swift", from: "0.9.1")
]

Then import it in your Swift files:

import ModelHealth

3D View (optional)​

To embed the interactive 3D view, also add the ModelHealthUI product to your target — it's a separate product so apps that don't need it don't pay for WebKit/SwiftUI. See the 3D View guide for usage, or jump straight to the Swift UI SDK Reference.

TypeScript SDK​

Requirements​

  • Node.js 16.0+
  • Modern browser with WebAssembly support

npm​

npm install @modelhealth/modelhealth@0.9.1

Then import it in your TypeScript files:

import { ModelHealthClient } from '@modelhealth/modelhealth';

3D View (optional)​

npm install @modelhealth/viewer-react@0.9.1

See the 3D View guide for usage, or jump straight to the TypeScript UI SDK Reference.

Python SDK​

Requirements​

  • Python 3.11+

pip​

pip install modelhealth==0.9.1

Then import it in your Python files:

from modelhealth import ModelHealthClient

Verification​

Once installed, verify the SDK is set up correctly by initializing it with your API key.

import ModelHealth

do {
    let client = try ModelHealthClient(apiKey: "your-api-key-here")
    print("Model Health SDK initialized successfully")
} catch {
    print("Failed to initialize: \(error)")
}

Note: These snippets are provisional and may change before the 1.0 release. If something doesn't work as expected, check the Swift Reference, TypeScript Reference, or Python SDK Reference for the latest API.

Next Steps​

Now that you have the SDK installed, check out the Quick Start Guide to build your first integration.