API

The QuantBayes Studio API lets users create projects, manage cases, record evidence, run QuantBayes, and retrieve results.

Base URL:

https://quantbayes.com

Authentication

API requests use bearer token authentication.

Authorization: Bearer <QB_API_KEY>

API keys are managed from the QuantBayes Studio account page.

Content type

Requests with JSON bodies should use:

Content-Type: application/json

Projects

GET  /api/v1/projects
POST /api/v1/projects

Create or list project workspaces.

POST body fields:

name
description
domain

Allowed domains:

general
clinical_genetics
wet_lab
crispr
ai_verification
other

Profiles

GET /api/v1/profiles
GET /api/v1/profiles/{profileUid}

List visible evidence profiles or retrieve a profile with its rules.

Cases

GET  /api/v1/cases
POST /api/v1/cases

Create or list cases.

POST body fields:

project_id
case_uid
title
description
case_type
metadata

Case evidence

GET  /api/v1/cases/{caseUid}/evidence?profile_uid=<profileUid>
POST /api/v1/cases/{caseUid}/evidence

Record or retrieve evidence for a case under a selected profile.

POST body fields:

profile_uid
items
outcomes

Each outcome should include:

item_uid
rule_uid
raw_outcome
source_value
notes
provenance

Allowed raw outcomes:

TRUE
FALSE
NA

Evidence batch endpoint

POST /api/v1/evidence

Batch endpoint for creating case items and writing evidence outcomes.

Required body fields:

case_uid
profile_uid
items

Each item may include:

item_uid
item_type
label
metadata
evidence

Each evidence entry may include:

rule_uid
raw_outcome
source_value
notes
provenance

Runs

GET  /api/v1/runs
POST /api/v1/runs
GET  /api/v1/runs/{runUid}

Create a QuantBayes run or retrieve saved runs and results.

POST body fields:

case_uid
profile_uid
run_uid

run_uid is optional. If omitted, the platform creates one.

Usage

GET /api/v1/usage

Returns account usage, API key metadata, and recent usage events.

Error format

Errors use JSON responses with a stable error code and message.

Typical fields:

error
message

Interpretation boundary

API results describe evidence sufficiency under the selected profile. They do not directly establish truth, pathogenicity, safety, regulatory acceptability, or clinical actionability.