Skip to Content
ReferencePipeline API

Pipeline API

SeqDesk exposes read-only API endpoints for discovering available analysis pipelines, fetching their metadata, and downloading versioned packages.

For sequencing-technology endpoints see the Sequencing Technology API.

Base URL

Use your deployment host with /api:

  • Public SeqDesk: https://seqdesk.com/api
  • Self-hosted: https://<your-host>/api

Endpoints

MethodPathPurpose
GET/registryPipeline registry index (available pipelines + categories)
GET/registry/{id}Full metadata for one pipeline
GET/registry/pipelines/{id}/{version}/downloadPackage payload for one pipeline version

Usage Examples

1. List available pipelines

curl -s https://seqdesk.com/api/registry

Response shape:

{ "version": "1.0.0", "lastUpdated": "2026-02-25", "baseUrl": "https://seqdesk.com/api/registry", "pipelines": [ { "id": "mag", "latestVersion": "3.0.0", "versions": [ { "version": "3.0.0", "downloadUrl": "https://seqdesk.com/api/registry/pipelines/mag/3.0.0/download" } ] } ] }

2. Fetch one pipeline definition

curl -s https://seqdesk.com/api/registry/mag

This returns the full pipeline metadata (description, DAG steps, requirements, features, etc.).

3. Download a specific package version

curl -s https://seqdesk.com/api/registry/pipelines/mag/3.0.0/download

This returns the packaged payload (for example manifest.json, definition.json, parser configs, and templates) used by SeqDesk to install or run that pipeline version.

Error Responses

/registry/{id} and /registry/pipelines/{id}/{version}/download validate path parameters and return:

  • 400 for invalid IDs/versions
  • 404 for unknown pipeline/package
  • 500 for server-side load errors

Caching and CORS

  • Pipeline endpoints are served with CDN cache headers (s-maxage=300, stale-while-revalidate=600).
  • Browser-accessible cross-origin endpoints include permissive CORS headers (Access-Control-Allow-Origin: *): /registry, /registry/{id}, /registry/pipelines/{id}/{version}/download.