REST reference

Base URL:

https://api.biosimulant.com/v1

Authenticate with a scoped key:

Authorization: Bearer bsk_live_...

Endpoints

Method	Path	Purpose
`GET`	`/capabilities`	List runnable lab versions and schemas
`GET`	`/capabilities/{namespace}/{name}`	Get the latest accessible capability
`GET`	`/compute-profiles`	List compute resources, limits, and credit rates
`POST`	`/runs`	Validate, reserve credits, and enqueue a run
`GET`	`/runs`	List owned developer-API runs
`GET`	`/runs/{id}`	Retrieve one run
`GET`	`/runs/{id}/results`	Read public outputs, artifacts, and provenance
`GET`	`/runs/{id}/events`	Read cursor-based progress and logs
`POST`	`/runs/{id}/cancel`	Idempotently request cancellation
`GET`	`/runs/{id}/artifacts/{artifact_id}`	Download an authorized artifact

Create a run

curl https://api.biosimulant.com/v1/runs \
  -H "Authorization: Bearer $BIOSIMULANT_API_KEY" \
  -H "Idempotency-Key: growth-sample-17" \
  -H "Content-Type: application/json" \
  -d '{
    "ref": "demi/microbiology-hello-world-growth@1.0.0",
    "inputs": {"initial_cells": 10},
    "metadata": {"sample_id": "17"}
  }'

The machine-readable OpenAPI 3 document is generated from the backend routes and committed with this site.

Billing Overview