Home Features Solutions Technology About Training Data Provider Dashboard Training Data Consumer Dashboard Confidential Clean Room Provider Dashboard System Administrator Dashboard API Reference Architecture Guide User Guide Security Guide Compliance Guide Getting Started SDK Documentation Integration Guide Code Examples Deployment Guide Get Started

SDK Overview

The Confidential AI Network SDK provides a comprehensive set of tools for integrating with our platform programmatically.

SDK Features
  • Multi-language Support: JavaScript/Node.js, Python, and Java
  • Type Safety: Full TypeScript definitions for JavaScript
  • Comprehensive Coverage: All platform APIs and features
  • Security First: Built-in authentication and encryption
  • Developer Experience: Intuitive API design with extensive documentation
JavaScript/Node.js

Primary SDK with full TypeScript support, comprehensive examples, and npm package distribution.

TypeScript npm ES6+
Python

Python SDK with async support, comprehensive data science integration, and pip package distribution.

Python 3.8+ Async pip

Installation

Get started with the Confidential AI Network SDK in your preferred programming language.

JavaScript/Node.js Installation
Using npm
npm install @contractflow-pro/sdk
Using yarn
yarn add @contractflow-pro/sdk
Basic Import
import { ContractFlowPro } from '@contractflow-pro/sdk';

// Initialize the SDK
const client = new ContractFlowPro({
    apiKey: 'your-api-key',
    environment: 'production'
});
Python Installation
Using pip
pip install contractflow-pro-sdk
Using conda
conda install -c contractflow-pro contractflow-pro-sdk
Basic Import
from contractflow_pro import ContractFlowPro

# Initialize the SDK
client = ContractFlowPro(
    api_key='your-api-key',
    environment='production'
)

Authentication

Secure authentication methods for accessing Confidential AI Network APIs.

API Key Authentication
Setup
  1. Generate API key in your dashboard
  2. Store key securely (environment variables)
  3. Initialize SDK with key
  4. Key automatically included in requests
Security Best Practices
  • Never commit API keys to version control
  • Use environment variables or secure vaults
  • Rotate keys regularly
  • Limit key permissions to minimum required
OAuth 2.0 Authentication
OAuth Flow
  1. Register OAuth application
  2. Implement authorization flow
  3. Handle callback and token exchange
  4. Use refresh tokens for long-term access
Supported Scopes
  • read:contracts - Read contract information
  • write:contracts - Create and modify contracts
  • read:data - Access dataset metadata
  • write:data - Upload and manage datasets
Code Examples
JavaScript/TypeScript
import { ContractFlowPro } from '@contractflow-pro/sdk';

const client = new ContractFlowPro({
    apiKey: process.env.CONTRACTFLOW_API_KEY,
    environment: process.env.NODE_ENV || 'development'
});

// Test connection
try {
    const user = await client.auth.getCurrentUser();
    console.log('Authenticated as:', user.email);
} catch (error) {
    console.error('Authentication failed:', error.message);
}
Python
import os
from contractflow_pro import ContractFlowPro

client = ContractFlowPro(
    api_key=os.environ['CONTRACTFLOW_API_KEY'],
    environment=os.environ.get('ENVIRONMENT', 'development')
)

# Test connection
try:
    user = client.auth.get_current_user()
    print(f'Authenticated as: {user.email}')
except Exception as error:
    print(f'Authentication failed: {error.message}')

Core Modules

Essential SDK modules for interacting with Confidential AI Network platform features.

User Management
Available Methods
  • getCurrentUser() - Get authenticated user info
  • updateProfile(profile) - Update user profile
  • changePassword(oldPass, newPass) - Change password
  • enableMFA() - Enable multi-factor authentication
User Object Properties
  • id - Unique user identifier
  • email - User email address
  • role - User role (TDP, TDC, CCRP, Admin)
  • organization - User's organization
Contract Management
Available Methods
  • createContract(data) - Create new contract
  • getContract(id) - Retrieve contract details
  • listContracts(filters) - List contracts with filters
  • signContract(id) - Sign contract digitally
Contract Object Properties
  • id - Contract identifier
  • status - Contract status
  • parties - Contract participants
  • terms - Contract terms and conditions
Dataset Management
Available Methods
  • uploadDataset(file, metadata) - Upload dataset
  • getDataset(id) - Get dataset details
  • listDatasets(filters) - List available datasets
  • updateDataset(id, updates) - Update dataset
Dataset Object Properties
  • id - Dataset identifier
  • name - Dataset name
  • size - Dataset size in bytes
  • metadata - Dataset metadata
AI Training
Available Methods
  • startTraining(config) - Start training job
  • getTrainingStatus(id) - Get training progress
  • listTrainingJobs(filters) - List training jobs
  • downloadResults(id) - Download training results
Training Object Properties
  • id - Training job identifier
  • status - Training status
  • progress - Training progress percentage
  • config - Training configuration

Contract Management

Comprehensive contract operations using the SDK.

Creating Contracts
JavaScript/TypeScript
const contract = await client.contracts.create({
    type: 'data_licensing',
    datasetId: 'dataset-123',
    terms: {
        usage: 'ai_training',
        duration: '12_months',
        restrictions: ['no_redistribution']
    },
    pricing: {
        model: 'per_usage',
        rate: 0.01
    }
});

console.log('Contract created:', contract.id);
Python
contract = client.contracts.create({
    'type': 'data_licensing',
    'dataset_id': 'dataset-123',
    'terms': {
        'usage': 'ai_training',
        'duration': '12_months',
        'restrictions': ['no_redistribution']
    },
    'pricing': {
        'model': 'per_usage',
        'rate': 0.01
    }
})

print(f'Contract created: {contract.id}')
Contract Operations
Contract Retrieval
const contract = await client.contracts.get('contract-123');
Contract Listing
const contracts = await client.contracts.list({ status: 'active' });
Contract Signing
await client.contracts.sign('contract-123');
Contract Updates
await client.contracts.update('contract-123', { status: 'amended' });

Data Operations

Managing datasets and data access through the SDK.

Dataset Upload
JavaScript/TypeScript
const dataset = await client.datasets.upload(
    'path/to/dataset.csv',
    {
        name: 'Financial Fraud Dataset',
        description: 'Historical fraud detection data',
        category: 'financial',
        privacyLevel: 'confidential',
        compliance: ['GDPR', 'SOX']
    }
);

console.log('Dataset uploaded:', dataset.id);
Python
dataset = client.datasets.upload(
    'path/to/dataset.csv',
    {
        'name': 'Financial Fraud Dataset',
        'description': 'Historical fraud detection data',
        'category': 'financial',
        'privacy_level': 'confidential',
        'compliance': ['GDPR', 'SOX']
    }
)

print(f'Dataset uploaded: {dataset.id}')
Dataset Management
List Datasets
const datasets = await client.datasets.list({ category: 'financial' });
Get Dataset
const dataset = await client.datasets.get('dataset-123');
Update Dataset
await client.datasets.update('dataset-123', { description: 'Updated description' });
Delete Dataset
await client.datasets.delete('dataset-123');

AI Training Integration

Integrate AI model training workflows with the Confidential AI Network platform.

Starting Training Jobs
JavaScript/TypeScript
const trainingJob = await client.training.start({
    modelType: 'neural_network',
    datasetIds: ['dataset-123', 'dataset-456'],
    hyperparameters: {
        learningRate: 0.001,
        batchSize: 32,
        epochs: 100
    },
    privacySettings: {
        differentialPrivacy: true,
        epsilon: 1.0
    }
});

console.log('Training started:', trainingJob.id);
Python
training_job = client.training.start({
    'model_type': 'neural_network',
    'dataset_ids': ['dataset-123', 'dataset-456'],
    'hyperparameters': {
        'learning_rate': 0.001,
        'batch_size': 32,
        'epochs': 100
    },
    'privacy_settings': {
        'differential_privacy': True,
        'epsilon': 1.0
    }
})

print(f'Training started: {training_job.id}')
Monitoring Training Progress
Get Status
const status = await client.training.getStatus('job-123');
List Jobs
const jobs = await client.training.listJobs({ status: 'running' });
Cancel Job
await client.training.cancel('job-123');
Download Results
const results = await client.training.downloadResults('job-123');

Error Handling

Proper error handling patterns for robust SDK integration.

Error Types
Authentication Errors
  • InvalidApiKeyError - Invalid or expired API key
  • UnauthorizedError - Insufficient permissions
  • TokenExpiredError - OAuth token expired
Validation Errors
  • ValidationError - Invalid input data
  • RequiredFieldError - Missing required fields
  • InvalidFormatError - Incorrect data format
Resource Errors
  • NotFoundError - Resource not found
  • ConflictError - Resource conflict
  • RateLimitError - API rate limit exceeded
Network Errors
  • ConnectionError - Network connection failed
  • TimeoutError - Request timeout
  • ServerError - Server-side error
Error Handling Examples
JavaScript/TypeScript
try {
    const contract = await client.contracts.create(contractData);
    console.log('Contract created:', contract.id);
} catch (error) {
    if (error instanceof ValidationError) {
        console.error('Validation failed:', error.details);
    } else if (error instanceof UnauthorizedError) {
        console.error('Authentication required');
    } else {
        console.error('Unexpected error:', error.message);
    }
}
Python
try:
    contract = client.contracts.create(contract_data)
    print(f'Contract created: {contract.id}')
except ValidationError as error:
    print(f'Validation failed: {error.details}')
except UnauthorizedError:
    print('Authentication required')
except Exception as error:
    print(f'Unexpected error: {error.message}')