Flywheel Core API

Full REST API for the Flywheel platform, covering the container hierarchy (groups, projects, subjects, sessions, acquisitions, files, analyses), gears and jobs, users and permissions, and search. Documented with Swagger and served per customer instance at /api (interactive docs at /api/docs). Consumed via the official Python SDK and CLI.

API entry from apis.yml

apis.yml Raw ↑
name: Flywheel Core API
description: Full REST API for the Flywheel platform, covering the container hierarchy (groups, projects,
  subjects, sessions, acquisitions, files, analyses), gears and jobs, users and permissions, and search.
  Documented with Swagger and served per customer instance at <instance>/api (interactive docs at <instance>/api/docs).
  Consumed via the official Python SDK and CLI.
humanURL: https://docs.flywheel.io/Developer_Guides/api_sdk/
baseURL: https://api-docs.flywheel.io/latest/index.html
x-baseurl-note: The live API base is per-instance (<instance>/api); the public reference is the generated
  SDK/API documentation host. No single public production base URL is published.
tags:
- Medical Imaging
- REST
properties:
- type: APIReference
  url: https://api-docs.flywheel.io/latest/index.html
- type: Documentation
  url: https://docs.flywheel.io/Developer_Guides/