APIREST API Reference

REST API Reference

The REST API lets you manage workflows and runs programmatically. Base URL:

https://api.bionodulo.com/v1

All requests require a bearer token — see Authentication.

This reference is a stub describing the intended stable API. Endpoints and fields may expand as the platform matures.

Workflows

List workflows

GET /v1/workflows
{
  "data": [
    { "id": "wf_123", "name": "Variant calling", "updatedAt": "2026-01-01T00:00:00Z" }
  ]
}

Get a workflow

GET /v1/workflows/{workflowId}

Returns the workflow including its JSON graph.

Create a workflow

POST /v1/workflows
Content-Type: application/json
 
{ "name": "My pipeline", "graph": { "version": "1", "nodes": [], "edges": [] } }

Runs

Start a run

POST /v1/workflows/{workflowId}/runs
Content-Type: application/json
 
{ "resourceTier": "medium" }
{ "id": "run_456", "status": "queued", "resourceTier": "medium" }

resourceTier is one of micro, small, medium, large, xlarge, extreme, bounded by your subscription. See Resource Tiers.

Get run status

GET /v1/runs/{runId}
{
  "id": "run_456",
  "status": "running",
  "progress": 0.6,
  "creditsUsed": 184,
  "nodes": [
    { "id": "bwa", "status": "done" },
    { "id": "haplotypecaller", "status": "running" }
  ]
}

status is one of queued, running, succeeded, failed, canceled.

Cancel a run

POST /v1/runs/{runId}/cancel

List run artifacts

GET /v1/runs/{runId}/artifacts

Returns downloadable output files (those connected to Output nodes).

Pagination & errors

  • List endpoints accept ?limit= and ?cursor=.
  • Errors use standard HTTP status codes with a JSON { "error": { "code", "message" } } body.

Real-time

For live progress instead of polling, use WebSocket events.

AuthenticationWebSocket Events