Documentation

Getting started

Create an account, connect your lab and push your first sample through the pipeline.

1. Create a workspace

Register at portal.serapis.top using an institutional e-mail. Your workspace is provisioned in your chosen region.

2. Generate an API token

Tokens are scoped per environment. Store them in your secrets manager — never in source control.

curl -X POST https://api.serapis.top/v1/tokens \
  -H "Authorization: Bearer $ADMIN_TOKEN" \
  -d '{"scope":"samples:write variants:read","ttl":2592000}'

3. Register your first sample

curl -X POST https://api.serapis.top/v1/samples \
  -H "Authorization: Bearer $TOKEN" \
  -d '{"accession":"SMP-00001","assay":"WGS-001","priority":"routine"}'

API reference

A versioned REST API for samples, variants, reports and webhook subscriptions.

Authentication

Bearer tokens. Rate-limited per workspace. All endpoints return JSON with a stable id field.

Core resources

GET    /v1/samples
POST   /v1/samples
GET    /v1/samples/{id}
GET    /v1/samples/{id}/variants
GET    /v1/reports/{id}
POST   /v1/webhooks

Example: list variants for a sample

GET /v1/samples/SMP-00001/variants?classification=pathogenic
Authorization: Bearer $TOKEN

Response

{
  "items": [
    {
      "gene": "BRCA1",
      "hgvs": "NM_007294.4:c.5266dupC",
      "classification": "pathogenic",
      "reviewStatus": "signed-out"
    }
  ],
  "nextCursor": null
}

Guides

Step-by-step recipes for common clinical and research workflows.

• Integrating with an existing LIS via HL7 v2
• Pushing FASTQ files from an Illumina instrument
• Building a custom cohort query
• Exporting a signed report as a FHIR bundle
• Setting up multi-region data residency
• Configuring SSO with SAML or OIDC

FAQ

Security, compliance, billing and data residency — answered.

Where is my data stored?

Inside the region you selected when creating the workspace: EU-West, US-East or APAC-Southeast. Data never leaves the chosen region.

Is Serapis GDPR compliant?

Yes. We act as a data processor under GDPR, support EU data residency, and provide a Data Processing Agreement on request.

How is billing calculated?

Per-sample processing fees plus storage. Enterprise agreements with volume discounts are available.

Do you support HIPAA workloads?

Yes. A Business Associate Agreement is available for US customers using the US-East region.

Changelog