Terra API documentation?
Hello,
I heard Terra has a programmatic API. I'm assuming the API roughly would allow code I write to do what humans would use the Web interface for. Is that right? Where can I find documentation for the Terra APIs? Thanks!
Best, Oliver
Comments
2 comments
Hi Oliver,
There are different ways to access the Terra API to do what users can do through the web interface.
1. There is a swagger link https://api.firecloud.org/ , to use the swagger API you need to authorize and sign in to your terra account through email.
2. Also the GitHub, https://github.com/broadinstitute/fiss, to use in python you need to "pip install firecloud", then from firecloud import API as fapi. Afterward, you can use fapi.(name of the function) to make API calls
Sidenote: Terra used to be called firecloud
Best,
Marianie
Just in case someone finds this: there is now a documentation article that provides more details about how to use the Terra API and the FISS library (including example notebooks) here: https://support.terra.bio/hc/en-us/articles/360042259232-Manage-data-automate-workflows-with-the-FISS-API
Please sign in to leave a comment.