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
  • Verify API key
  • Sample Usage
  1. Public API (Beta)

Authentication

PreviousOverviewNextExamples

Last updated 2 years ago

To authenticate with the public API, you must first . You can generate an API key by going to Settings -> API and pressing the Generate button.

IMPORTANT: Your API keys grant access to your data, so please keep them secure.

It is highly recommended you also turn on copyable ids. You can do this by ensuring the checkbox is enabled.

Once you have an API key, you can verify it is working using the following endpoint.

Verify API key

GET https://app.biodock.ai/api/external/check

Headers

Name
Type
Description

X-API-KEY*

String

API key.

{
    user: "auth0|1234567890",
    email: "michael@biodock.ai",
    messsage: "API key is valid."
}

Sample Usage

import requests

API_KEY = "" # Replace with your api key
URL = "https://app.biodock.ai/api/external/check"

headers = {"X-API-KEY": API_KEY, "Content-Type": "application/json"}

response = requests.get(URL, headers=headers)
print(response.text)

generate an API key