API Reference¶

Flow provides REST APIs for programmatic access. Each service exposes OpenAPI-documented endpoints.

Interactive API Documentation¶

Each service provides live, interactive API documentation:

Try it out

Swagger UI allows you to test API calls directly in the browser after authenticating.

Environment	Pattern	Example
Production	`<service>.iflow.intelliseq.com`	`miner.iflow.intelliseq.com`
Staging	`<service>.stg.iflow.intelliseq.com`	`miner.stg.iflow.intelliseq.com`
Development (Docker Compose)	`<service>.flow.labpgx.com`	`miner.flow.labpgx.com`

Services surfaced on the public API: admin, compute, files, miner, report, vcf, audit.

Endpoint	Method	Description
`/orgs`	GET	List organizations
`/projects`	GET	List projects
`/projects/{id}`	GET	Get project details
`/projects/{id}/credentials`	GET	Get project credentials
`/users/me/default-context`	GET/PUT	Get/set default project context

Endpoint	Method	Description
`/pipelines`	GET	List available pipelines
`/pipelines`	POST	Create new pipeline
`/pipelines/slug/{slug}`	GET	Get pipeline by slug
`/pipelines/slug/{slug}/versions`	GET	List pipeline versions
`/runs`	GET	List runs
`/runs`	POST	Submit new run
`/runs/{id}`	GET	Get run details
`/runs/{id}/outputs`	GET	Get run outputs

Endpoint	Method	Description
`/subjects`	GET/POST	List or create subjects
`/subjects/{id}`	GET/PATCH/DELETE	Get, update, or delete subject
`/samples`	GET/POST	List or create samples
`/samples/{id}`	GET/PATCH/DELETE	Get, update, or delete sample
`/samples/{id}/sampleinfo`	GET	Generate pipeline-ready JSON
`/orders`	GET/POST	List or create orders
`/orders/{id}`	GET/PUT/DELETE	Get, update, or delete order
`/orders/{id}/transition`	POST	Transition order status
`/orders/{id}/samplesheet`	GET	Generate nf-core samplesheet CSV
`/orders/{id}/samples`	GET/POST	List or add samples to order

Endpoint	Method	Description
`/files`	GET	List files in path
`/files/download-url`	GET	Get signed download URL (two-step: get URL, then download)
`/files/upload-url`	POST	Get signed upload URL (two-step: get URL, then PUT file)
`/files/copy`	POST	Copy file within bucket
`/files/move`	POST	Move/rename file within bucket
`/files`	DELETE	Delete file