Back to News
DocumentationOctober 15, 2024CCA Team

New API Documentation Portal

Comprehensive API documentation portal with interactive examples and code snippets for Microscope, Pebble, and Labs.

New API Documentation Portal

We've launched a comprehensive API documentation portal covering all three CCA products: Microscope, Pebble, and Labs.

What's Included

Microscope API

Complete reference for:

  • Image capture and retrieval
  • Environmental control (temperature, CO₂, humidity)
  • Stage positioning for SBS plates
  • Time-lapse scheduling
  • Metadata and status queries

Pebble API

Documentation for:

  • Real-time sensor data retrieval
  • Historical data queries
  • Multi-sensor aggregation
  • Alert configuration
  • CSV export endpoints

Labs API

Full coverage of:

  • Protocol CRUD operations
  • Version control and history
  • Experiment data access
  • Inventory queries
  • Scheduling endpoints

Interactive Examples

Each endpoint includes:

  • Request/response examples in Python, JavaScript, and curl
  • Try-it-now functionality in the browser
  • Common use case patterns
  • Error handling guidance

Code Snippets

Ready-to-use code for common workflows:

Automated time-lapse with environmental monitoring:

import requests
import time

microscope = "http://microscope.local"
pebble = "http://pebble-base.local"

for i in range(24):  # 24 hours
    # Capture image
    img = requests.post(f"{microscope}/api/capture",
        json={'position': 'A1'}).json()
    
    # Get environmental data
    env = requests.get(f"{pebble}/api/sensors/current").json()
    
    # Log both together
    print(f"Hour {i}: {env['temp']}°C, Image: {img['url']}")
    
    time.sleep(3600)  # Wait 1 hour

Getting Started

Visit the documentation portal to:

  1. Generate your API keys
  2. Browse endpoint references
  3. Try interactive examples
  4. Download code snippets

Support

Questions about the API? Contact hello@cca.bio or join our developer community discussions.

All three product APIs are designed for custom integrations in modern lab environments.