Use the API credentials to read and write data to Benchling. The API will be used by any service that writes instrument data to Benchling.

Enable Developer Platform

Prior to the steps below, please ensure that you have access to the Benchling API. This can be done through the Capability Management tool by managing application access to the Developer Platform. Make sure access is set to full.

To create API credentials, navigate to your personal settings. 

Set up API access credentials

Use the API credentials to read and write data to Benchling. The API will be used by any service that writes instrument data to Benchling.

To create API credentials, click the Generate API Key button at the bottom of your User Settings Page.

Once you've generated your personal API key, you can access the Benchling API.

For documentation on the Benchling API, please visit https://docs.benchling.com for guides, tutorials and https://benchling.com/api/reference for the full list of supported endpoints.

Note: If you do not see the API Keys section on your user page, please contact your CS representative to have API access enabled for your account.

Managing API Credentials

Since access to Benchling's APIs is controlled by user-specific API keys, it is important to ensure these users' accounts are kept up-to-date in Benchling's UI.

Please note the following behaviors of Benchling account status and API access:

  • If a user is suspended in Benchling, their API key will no longer be allowed to call the API.

  • If a user is suspended in your identity provider, it does not automatically suspend that user in Benchling. To invalidate a user's API credentials, you must suspend the user in Benchling's admin console.

  • If a user is un-suspended in Benchling, their original API key will resume working normally and does not need to be regenerated.

Did this answer your question?