Product Documentation
HomepageLoginSign up
  • Welcome to Biodock
  • Why Biodock
  • Quickstart
    • Start here (choose a tutorial)
    • Path 1: AI-assisted analysis
    • Path 2: Train a fully-automated AI model
      • Set up your project
      • Label and train
      • Labeling shortcuts
      • Run your AI model
      • Configuring your model
  • AI Projects
    • Project settings
    • Sharing your AI project
    • Training a model
  • AI Analysis
    • Results dashboard overview
    • Download results and reports
    • Correcting results to improve your model
    • Editing objects (QC)
    • Filters (like flow cytometry)
  • Biodock Scripts
    • Biodock Platform Script Guidelines
  • Files
    • Uploading images
    • AWS S3 integration
    • View and manage data
      • Viewing images
      • File details and download
      • Copy, cut, move
      • Sharing data
      • Merging channels
    • Supported image types
  • Public API (Beta)
    • Overview
    • Authentication
    • Examples
    • Resources
      • Files
      • Analysis Jobs
      • Pipelines
    • Limitations
  • Deep AI models
    • Evaluating Performance
  • User
    • Account registration
    • Change password, login, logout
    • Usage limits and team
      • Filesize based limits
      • Run credits limits
    • Billing
  • Company
    • Academics and startups
    • Contact us
    • Citing Biodock
    • Security and IP
Powered by GitBook
On this page
  1. Public API (Beta)

Overview

Biodock provides a public REST API so that users can invoke actions on Biodock through simple web requests. This allows users to integrate an AI analysis built on Biodock into scripts and programs.

Biodock's public API is in beta, meaning that resources may change.

Also note that creating an AI model, which is a highly visual process in the labeler, cannot be done through our API.

Any action that is invoked through the API will also be tracked in our dashboard. For example, any files uploaded through the API will be visible in the Biodock Filesystem, and any Analysis Jobs submitted through the API will be visible on the results page.

Example use cases for our API

  • A script that automatically analyzes cell culture images acquired, three times a day, and uploads results to a cloud server.

  • A sync tool that uploads data to one place (Biodock) from multiple imagers.

  • A continuously running alarm that runs quality control on samples and sends an alert when quality control fails.

  • Integrate Biodock into an internal tool, allowing users to submit files for analysis from an existing dashboard.

PreviousSupported image typesNextAuthentication

Last updated 2 years ago