To connect to Blackfynn using any client or command line tool, follow these steps:

  1. Create an API key/secret pair on website
  2. Configure client to use credentials
  3. Download and use a client

Create an API Key and Secret

To create an API key/secret pair, log in to Blackfynn and navigate to your profile settings. You can do this by clicking the circular icon with your initials in the bottom-left corner of the site to navigate to your My Settings page.

From there you can click the blue Create API Key button and give your new API key a name i.e. work laptop, as shown below.

After that you’ll see a dialog with your new API key/secret pair.

NOTE: Make sure to save your new API key/secret pair before exiting the dialog! For security purposes, you will not be able to view the key/secret again. You can always generate a new API key/secret in case you no longer have access to your old one.

Configure client to use credentials

The recommended way to store your API key/secret is with the Blackfynn Python client using the CLI.

  • Install the Python client
pip install -U blackfynn 
  • Create a profile by running bf profile create. Copy & paste your API key/secret from above:
$ bf profile create

Blackfynn profile setup assistant
Create a profile:
  Profile name [default]:
Creating profile 'default'
  API token: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
  API secret: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Would you like to set 'default' as default (Y/n)? y
Default profile: default

NOTE: See Create connection profile for more details and alternative methods using the CLI.

Using a client

  1. Python client: See Getting Started in Python
  2. Matlab client: See Getting Starting in MATLAB.
Did this answer your question?