Application Program Interface (API)¶
For experiments served with expfactory.org, we offer an interactive RESTful API, and a python module expanalysis specifically for retrieving and working with results. To use the API, you will need to provide a token generated when you log in to expfactory.org. First install the analysis package:
pip install expanalysis
Then when you have your token, here is how to use it from python:
from expanalysis.api import get_results access_token = "abcdefghijklmnopqrstuvwxyz" # expfactory.org/token results = get_results(access_token=access_token)
Running the API¶
After installation, start up the application.
Retrieving all Experiments¶
Retrieving a specific Experiment¶
The unique id of an experiment is its “exp_id,” which also corresponds to the name of its folder and the “exp_id” variable in its config.json. You can select an experiment by this unique id:
More API functions will come as requested. If there is a functionality you would desire, please tell us.