Comprehensive guide to integrating with Confidential AI Network using our Software Development Kit
The Confidential AI Network SDK provides a comprehensive set of tools for integrating with our platform programmatically.
Primary SDK with full TypeScript support, comprehensive examples, and npm package distribution.
Python SDK with async support, comprehensive data science integration, and pip package distribution.
Get started with the Confidential AI Network SDK in your preferred programming language.
npm install @contractflow-pro/sdk
yarn add @contractflow-pro/sdk
import { ContractFlowPro } from '@contractflow-pro/sdk';
// Initialize the SDK
const client = new ContractFlowPro({
apiKey: 'your-api-key',
environment: 'production'
});
pip install contractflow-pro-sdk
conda install -c contractflow-pro contractflow-pro-sdk
from contractflow_pro import ContractFlowPro
# Initialize the SDK
client = ContractFlowPro(
api_key='your-api-key',
environment='production'
)
Secure authentication methods for accessing Confidential AI Network APIs.
read:contracts - Read contract informationwrite:contracts - Create and modify contractsread:data - Access dataset metadatawrite:data - Upload and manage datasetsimport { 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);
}
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}')
Essential SDK modules for interacting with Confidential AI Network platform features.
getCurrentUser() - Get authenticated user infoupdateProfile(profile) - Update user profilechangePassword(oldPass, newPass) - Change passwordenableMFA() - Enable multi-factor authenticationid - Unique user identifieremail - User email addressrole - User role (TDP, TDC, CCRP, Admin)organization - User's organizationcreateContract(data) - Create new contractgetContract(id) - Retrieve contract detailslistContracts(filters) - List contracts with filterssignContract(id) - Sign contract digitallyid - Contract identifierstatus - Contract statusparties - Contract participantsterms - Contract terms and conditionsuploadDataset(file, metadata) - Upload datasetgetDataset(id) - Get dataset detailslistDatasets(filters) - List available datasetsupdateDataset(id, updates) - Update datasetid - Dataset identifiername - Dataset namesize - Dataset size in bytesmetadata - Dataset metadatastartTraining(config) - Start training jobgetTrainingStatus(id) - Get training progresslistTrainingJobs(filters) - List training jobsdownloadResults(id) - Download training resultsid - Training job identifierstatus - Training statusprogress - Training progress percentageconfig - Training configurationComprehensive contract operations using the SDK.
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);
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}')
const contract = await client.contracts.get('contract-123');
const contracts = await client.contracts.list({ status: 'active' });
await client.contracts.sign('contract-123');
await client.contracts.update('contract-123', { status: 'amended' });
Managing datasets and data access through the SDK.
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);
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}')
const datasets = await client.datasets.list({ category: 'financial' });
const dataset = await client.datasets.get('dataset-123');
await client.datasets.update('dataset-123', { description: 'Updated description' });
await client.datasets.delete('dataset-123');
Integrate AI model training workflows with the Confidential AI Network platform.
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);
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}')
const status = await client.training.getStatus('job-123');
const jobs = await client.training.listJobs({ status: 'running' });
await client.training.cancel('job-123');
const results = await client.training.downloadResults('job-123');
Proper error handling patterns for robust SDK integration.
InvalidApiKeyError - Invalid or expired API keyUnauthorizedError - Insufficient permissionsTokenExpiredError - OAuth token expiredValidationError - Invalid input dataRequiredFieldError - Missing required fieldsInvalidFormatError - Incorrect data formatNotFoundError - Resource not foundConflictError - Resource conflictRateLimitError - API rate limit exceededConnectionError - Network connection failedTimeoutError - Request timeoutServerError - Server-side errortry {
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);
}
}
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}')