Skip to main content

The Agora Connector for Python

Project description

gtagora-connector Build Status

gtagora-connector is a python library to access GyroTools' Agora system.


Use the package manager pip to install gtagora-connector.

pip install gtagora-connector

Currently gtagora-connector supports python 3.6 and 3.7.

Basic usage

from gtagora import Agora
from gtagora.models.dataset import DatasetType

server = '<AGORA SERVER>'
api_key = '<YOUR_API_KEY>'

agora = Agora.create(server, api_key)

myagora_project = agora.get_myagora()
root_folder = myagora_project.get_root_folder()
subfolders = root_folder.get_folders()
for s in subfolders:
    print(f' - {}')

new_folder = root_folder.get_or_create('New Folder')

exams = myagora_project.get_exams(filters={'name': 'Wrist'})
if exams:
    exam = exams[0]
    for s in exam.get_series():
        print(f'Series: {}')

        for dataset in s.get_datasets(filters={'type': DatasetType.PHILIPS_RAW}):
            for datafile in dataset.get_datafiles():

agora.import_data('/path/to/directroy', new_folder)


Create an Agora instance

from gtagora import Agora

agora = Agora.create('', user='test', password='test')

Since, it is not recommended to ever write down your password in plain text, Agora offers the possibility to connect with an API key. The API key can be activated in your Agora profile, and is a random UUID which can be withdrawn or recreated easily.

from gtagora import Agora

agora = Agora.create('', api_key='<YOUR_API_KEY>')

Working with projects

Get a list of projects:

projects = agora.get_projects()
for p in projects:
    print(f" - {p.display_name}")

Get a project by ID:

project = agora.get_project(2)
print(f" - {project.display_name}")

Get the "My Agora" project:

myagora = agora.get_myagora()

Get root folder of a project

project = agora.get_project(2)
root_folder = project.get_root_folder()

Get all exams of a project

project = agora.get_project(2)
exams = project.get_exams()

Empty the trash

project = agora.get_project(2)

Working with folders

Get the root folder of the "My Agora" project:

myagora = agora.get_myagora()
root_folder = myagora.get_root_folder()
print(f"Root folder ID: {}")

Get a folder by its ID

folder = agora.get_folder(45)
print(f"Folder with ID {}")

Get sub folders

subfolders = folder.get_folders()
for f in subfolders:
    print(f" - {}")

Get a subfolder folder by name. None will be returned if the folder does not exist

my_folder = folder.get_folder('my_folder')

The get_folder function also takes a relative path.

my_folder = folder.get_folder('../../data/my_folder')

Create a new folder in the root folder (the new folder object is returned). An exception is thrown if a folder with the same name already exists.

new_folder = root_folder.create_folder('TestFolder')
print(f"New folder ID: {}")

Get a folder or create a new one if it does not exist

new_or_existing_folder = root_folder.get_or_create('TestFolder')

Delete a folder. Delete a folder is recursive. It deletes all items. The delete operation does not follow links.


Get all items of a folder. An item could for example be an exam, series or dataset

items = folder.get_items()
for item in items:
    print(f" - {item}")

Get all exams of a folder. Use the recursive parameter to also get the exams in all subfolders

exams = folder.get_exams(recursive=False)
for exam in exams:
    print(f" - {exam}")

Get all datasets of a folder. Use the recursive parameter to also get the exams in all subfolders

datasets = folder.get_datasets(recursive=False)

Get a dataset by name. None is returned if the dataset does not exist

dataset = folder.get_dataset('my_dataset')

Get the path of a folder within Agora (breadcrumb)

folder = agora.get_folder(45)
breadcrumb = folder.get_breadcrumb()

Working with Agora objects

Get the list of exams

exams = agora.get_exam_list()

Get an exam by ID

exam = agora.get_exam(12)

Link the first Exam to the a folder

exam_item = exam.link_to_folder(

Delete the link of an exam (doesn't delete the Exam itself)


Get all series of an exam and then all datasets of the first series

series = exam.get_series()
datasets = series[0].get_datasets()

Get all datasets of an exam

series = exam.get_datasets()

Get a list of all patients

patients = agora.get_patients()

Get a patient by ID

patient = agora.get_patient(15)

Get a series or dataset by ID

series = agora.get_series(76)
dataset = agora.get_dataset(158)

Tag Objects

Get all tags the current user has access to:

tags = agora.get_tags()

Get a tag by id or name:

tag1 = agora.get_tag(id=3)
tag2 = agora.get_tag(name='good')

Tag an agora object:

exam = agora.get_exam(12)
series = agora.get_series(24)
dataset = agora.get_dataset(145)
folder = agora.get_folder(15)
patient = agora.get_patient(2)

tag_instance1 = exam.tag(tag1)
tag_instance2 = series.tag(tag1)
tag_instance3 = dataset.tag(tag1)
tag_instance4 = folder.tag(tag1)
tag_instance5 = patient.tag(tag1)

Download data

Download all data from a folder

from pathlib import Path

target = Path("c:/temp")
downloaded_files =, recursive=False)
for f in downloaded_files:

Exams, series and datasets also have a download function

downloaded_files =
downloaded_files =
downloaded_files =

Import data

Upload files into a folder

from pathlib import Path

folder = agora.get_folder(45)
file1 = Path('C:/images/test1.jpg')
file2 = Path('C:/images/test2.jpg')
folder.upload([file1, file2])

Upload a whole folder structure

from pathlib import Path

folder = agora.get_folder(45)
data = Path('C:/data/my_folder')

Upload (and import) a rawfile and add an additional file to the the created series (Agora version > 6.3.0):

In this example a scanner rawfile and a textfile is uploaded. The rawfile will be imported into Agora and a Study and Series will be created. We can add the additional text file to the created Series by specifying the "relations" attribute in the upload function. The "relations" attribute is a dictionary whose key is the path to the rawfile and the value is a list of additional files which will be added to the created series:

folder = agora.get_folder(45)

files = [

relations = {
'C:/data/raw/rawfile.raw' : ['C:/data/log/logfile.txt']

folder.upload(files, relations=relations)

This also works when uploading a whole directory:

folder = agora.get_folder(45)

dir = [Path('C:/data/')]

relations = {
'C:/data/raw/rawfile.raw' : ['C:/data/log/logfile.txt']

folder.upload(dir, relations=relations)

Working with tasks

Get all tasks visible to the current user:

tasks = agora.get_tasks()

Get a task by ID

task = agora.get_task(13)

Run a task.
In this example the task has 2 inputs:

  • A dataset with key "ds"
  • An integer number with key "size"

The last line in the code sample waits for the task to finish

task = agora.get_task(13)
target_folder = agora.get_folder(24)
dataset = agora.get_dataset(57)
taskinfo =, ds=dataset, size=1024)

alternatively only the ID's of the Agora objects can be given as argument:

taskinfo =, ds=23, size=1024)

the syntax to run the task can be printed to the console with the syntax function:


Save a task after it has been modified

task = agora.get_task(13) = 'new_name'

Delete a task


Export all tasks into a json file

agora.export_tasks('<output file>.json')

Import tasks from file (Experimental!)

agora.import_tasks('<input file>.json')

Working with parameters

Get a parameter by name

dataset = agora.get_dataset(13)
parameter = dataset.get_parameter('EX_ACQ_echoes')
if not parameter.is_array:
    value = parameter.values[0]
    value = parameter.values

Search for parameters

dataset = agora.get_dataset(13)
parameters = dataset.search_parameter('EX_ACQ_')
print(f'{len(parameters)} parameters found')

Users and sharing

Get the current user

current_user = agora.get_current_user()

Get all users

users = agora.get_users()

Get all user groups

users = agora.get_groups()


The members of any Agora object can be printed to the console with the display function

exam = agora.get_exam(22)

folder = agora.get_folder(15)


Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.



Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gtagora-connector-1.3.tar.gz (27.0 kB view hashes)

Uploaded source

Built Distribution

gtagora_connector-1.3-py3-none-any.whl (34.3 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page