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
  • List pipelines
  • Sample Usage
  1. Public API (Beta)
  2. Resources

Pipelines

The public API supports viewing active pipelines. To view active pipelines, use the following endpoint:

List pipelines

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

Query Parameters

Name
Type
Description

limit

Number

Maximum number of results to show.

startingAfter

String

Pagination cursor id.

Headers

Name
Type
Description

X-API-KEY*

String

API key.

{
    results: [{
        id: "0123456789",
        description: "My first pipeline",
        createdAt: "2000-01-01T00:00:00.001Z"
    }],
    count: 1
}

Sample Usage

View all your active pipelines

import requests

API_KEY = "" # Replace with your api key

URL = "https://app.biodock.ai/api/external/pipelines"
headers = {"X-API-KEY": API_KEY, "Content-Type": "application/json"}

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

Last updated 2 years ago