BioAssayAI API

📖 API Overview

The BioAssayAI API provides programmatic access to our AI-powered assay optimization engine. Integrate intelligent protocol recommendations, predictive analytics, and quality control directly into your laboratory workflows.

Key Features

🔐 Authentication

All API requests require authentication using Bearer tokens. Include your API key in the Authorization header:

Copy
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

Obtaining API Keys

1. Sign up for a BioAssayAI account
2. Navigate to Settings → API Keys
3. Click "Generate New Key"
4. Store your key securely (it won't be shown again)

Demo API Key

For testing and development, use this demo key with limited functionality:

demo_key_bioassayai_2025_limited

🛠️ API Endpoints

Copy
curl -X GET "https://api.bioassayai.com/v3/assays/ELISA_IL6?optimize=true" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Copy
import requests

response = requests.get(
    "https://api.bioassayai.com/v3/assays/ELISA_IL6",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Content-Type": "application/json"
    },
    params={"optimize": True}
)

data = response.json()
print(data)

Copy
const response = await fetch(
  'https://api.bioassayai.com/v3/assays/ELISA_IL6?optimize=true',
  {
    headers: {
      'Authorization': 'Bearer YOUR_API_KEY',
      'Content-Type': 'application/json'
    }
  }
);

const data = await response.json();
console.log(data);

Copy
{
  "id": "ELISA_IL6",
  "name": "Human IL-6 ELISA",
  "category": "Immunoassay",
  "version": "3.2.1",
  "ai_optimization": {
    "confidence_score": 0.985,
    "success_prediction": "98.5%",
    "model_version": "AssayNet-2025.Q1",
    "last_updated": "2025-02-15T10:30:00Z",
    "training_samples": 127000
  },
  "protocol": {
    "steps": [
      {
        "step": 1,
        "name": "Coating",
        "duration_minutes": 120,
        "temperature_celsius": 4,
        "critical_parameters": {
          "buffer": "Carbonate-bicarbonate pH 9.6",
          "antibody_concentration": "2 µg/mL",
          "volume": "100 µL/well"
        },
        "ai_tips": [
          "Overnight coating improves sensitivity by 15%",
          "Ensure plate is sealed to prevent evaporation"
        ]
      }
    ],
    "total_duration_minutes": 240
  },
  "performance_metrics": {
    "lod": "0.5 pg/mL",
    "loq": "1.5 pg/mL",
    "dynamic_range": "0.5-500 pg/mL",
    "cv_intra_assay": "< 5%",
    "cv_inter_assay": "< 8%",
    "recovery": "95-105%",
    "linearity": "R² > 0.999"
  },
  "quality_control": {
    "blank_od_max": 0.1,
    "positive_control_range": {
      "min": 1.5,
      "max": 2.5
    },
    "cv_threshold": 0.15
  },
  "ai_recommendations": [
    {
      "type": "optimization",
      "priority": "high",
      "suggestion": "Increase wash cycles to 6 for high-protein samples",
      "expected_improvement": "12% reduction in background"
    },
    {
      "type": "automation",
      "priority": "medium",
      "suggestion": "Use automated liquid handling for reagent dispensing",
      "expected_improvement": "CV reduction from 5% to 3%"
    }
  ],
  "compatibility": {
    "automation_ready": true,
    "lims_integration": ["LabWare", "STARLIMS", "LabVantage"],
    "instrument_compatibility": ["BioTek", "Molecular Devices", "Tecan"]
  }
}

🤖 AI Optimization Engine

Our machine learning models analyze millions of assay runs to provide real-time optimization suggestions.

Copy
{
  "assay_type": "ELISA",
  "target": "IL-6",
  "sample_type": "serum",
  "sample_volume_ul": 100,
  "lab_conditions": {
    "temperature": 22,
    "humidity": 45,
    "equipment": ["BioTek ELx800"]
  },
  "historical_issues": ["high_background", "poor_linearity"],
  "optimization_goals": ["reduce_cv", "improve_sensitivity"]
}

Copy
{
  "optimization_id": "opt_2025_abc123",
  "confidence_score": 0.92,
  "recommendations": [
    {
      "parameter": "blocking_buffer",
      "current": "1% BSA in PBS",
      "suggested": "3% BSA in PBS-T",
      "rationale": "Reduces non-specific binding by 40%",
      "confidence": 0.95
    },
    {
      "parameter": "incubation_time",
      "current": "60 minutes",
      "suggested": "90 minutes",
      "rationale": "Improves signal linearity",
      "confidence": 0.88
    }
  ],
  "predicted_improvements": {
    "cv_reduction": "35%",
    "sensitivity_increase": "2.5x",
    "success_rate": "96%"
  }
}

📦 Batch Operations

Process multiple assays simultaneously for high-throughput workflows.

Copy
{
  "assays": [
    {"id": "ELISA_IL6", "samples": 96},
    {"id": "qPCR_EGFR", "samples": 48},
    {"id": "WesternBlot_p53", "samples": 12}
  ],
  "lab_profile": "lab_profile_123",
  "priority": "high"
}

🔔 Webhooks

Receive real-time notifications for assay updates and optimization alerts.

⚠️ Error Handling

The API uses standard HTTP status codes and returns detailed error messages in JSON format.

Status Codes

Error Response Format

Copy
{
  "error": {
    "code": "ASSAY_NOT_FOUND",
    "message": "The requested assay does not exist",
    "details": "Assay ID 'INVALID_ID' not found in database",
    "timestamp": "2025-02-15T14:30:00Z",
    "request_id": "req_abc123xyz"
  }
}

Common Error Codes

• INVALID_API_KEY - API key is invalid or expired
• ASSAY_NOT_FOUND - Requested assay doesn't exist
• PARAMETER_MISSING - Required parameter not provided
• PARAMETER_INVALID - Parameter value is invalid
• RATE_LIMIT_EXCEEDED - Too many requests
• INSUFFICIENT_PERMISSIONS - API key lacks required permissions

⏱️ Rate Limits

API rate limits vary by subscription tier to ensure fair usage and system stability.

Rate Limit Headers

Every API response includes headers with rate limit information:

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1613472000

📚 SDKs & Libraries

Official SDKs and community libraries for popular programming languages.

pip install bioassayai

npm install @bioassayai/sdk

com.bioassayai:sdk:3.0.0

install.packages("bioassayai")

🔄 Migration Guide

Upgrading from v2 to v3? Follow our comprehensive migration guide.

Breaking Changes

• Authentication now uses Bearer tokens (previously API keys in query params)
• Response structure normalized across all endpoints
• Deprecated /analyze endpoint (use /assays instead)
• New required version header for API versioning

Migration Steps

1. Update authentication headers
2. Review response parsing logic
3. Update endpoint URLs
4. Test in staging environment
5. Deploy with monitoring

📝 Changelog

Version 3.0.0 Latest

Released: February 15, 2025

• New AI optimization engine with 98.5% accuracy
• Batch processing endpoints
• Webhook support for real-time notifications
• Enhanced error messages with request IDs
• Performance improvements (2x faster response times)

Version 2.8.0

Released: January 10, 2025

• Added 50 new assay protocols
• Improved ML model accuracy
• New lab profile customization

Version 2.7.0

Released: December 5, 2024

• Initial public API release
• Support for 450+ assay protocols
• Basic optimization features

🚀 Ready to Get Started?

Integrate BioAssayAI's intelligent optimization engine into your laboratory workflows today.

DISCLAIMER: This API demo environment is designed solely for demonstration of laboratory automation capabilities. All sample data is artificial and should NOT be used for clinical decision-making,diagnostics, research or production purposes. All endpoints return simulated data.