API Reference
Templates

Templates API

List Templates

GET /templates

Browse available protocol templates.

Query Parameters

ParameterTypeDescription
categorystringFilter by category
bsl_levelstringFilter by BSL level

Response

{
  "templates": [
    {
      "id": "mic-broth-microdilution-v2",
      "name": "MIC/MBC - Broth Microdilution",
      "description": "Standard broth microdilution for antimicrobial testing",
      "category": "microbiology",
      "bsl_level": "BSL-2",
      "estimated_cost_range": "$200-400"
    }
  ]
}

Categories

  • biochemistry — Enzyme assays, protein work
  • microbiology — Bacterial/fungal work
  • cell_biology — Mammalian cell culture
  • molecular_biology — PCR, cloning, sequencing
  • analytical — HPLC, mass spec

Get Template

GET /templates/{template_id}

Get full template details including parameters and protocol steps.

Response

{
  "id": "mic-broth-microdilution-v2",
  "name": "MIC/MBC - Broth Microdilution",
  "description": "Standard broth microdilution for antimicrobial testing",
  "category": "microbiology",
  "bsl_level": "BSL-2",
  "version": "2.0",
  "parameters": [
    {
      "name": "organism",
      "type": "string",
      "required": true,
      "description": "Target organism (e.g., E. coli ATCC 25922)"
    },
    {
      "name": "concentration_range_uM",
      "type": "array",
      "required": true,
      "description": "Concentrations to test"
    },
    {
      "name": "incubation_hours",
      "type": "integer",
      "default": "18",
      "description": "Incubation time"
    }
  ],
  "equipment_required": [
    "Biosafety cabinet",
    "Incubator (37°C)",
    "Plate reader (OD600)"
  ],
  "typical_materials": [
    {"name": "Mueller-Hinton broth", "catalog": "BD 275730"},
    {"name": "96-well plates", "catalog": "Corning 3596"}
  ],
  "estimated_duration_hours": 24,
  "estimated_cost_usd": {
    "low": 200,
    "high": 400
  },
  "protocol_steps": [
    {
      "step": 1,
      "action": "Prepare bacterial inoculum to 0.5 McFarland standard",
      "duration_minutes": 30
    }
  ]
}

Using Templates

Reference a template in your experiment submission:

{
  "protocol": {
    "type": "standard_template",
    "template_id": "mic-broth-microdilution-v2",
    "template_parameters": {
      "organism": "Escherichia coli ATCC 25922",
      "concentration_range_uM": [1, 2, 4, 8, 16, 32, 64, 128],
      "incubation_hours": 18
    }
  }
}
ValidationOperators