Document toolboxDocument toolbox

API Clients and Documentation

API clients provide a way to use Synapse programmatically. The API clients available to interface and access data within Synapse are: command line, python, and R.

Learn how to install Synapse API clients here.

Learn how to manage stored login credentials here.

Below, find links to Python, R, command line, and REST API documentation.

  • Command Line Docs : Connect and interact with Synapse directly using the command line client

  • Python Docs : Interact with Synapse using the python client

  • R Docs : Use the R client to interact with Synapse from scripts or interactive R sessions

  • REST API Docs : Build your own client using the Synapse REST APIs