Benchling In Vivo API

Corinne
Corinne
  • Updated

Download the latest API docs for Benchling In Vivo

Benchling In Vivo API

The Benchling In Vivo API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.


Documentation Navigation

Download the html.zip file below, unzip the file on your computer and open this in your browser. Click on the relevant section titles in the left had panel to quickly navigate to this section of the API docs.

Generating API keys:

Administrators on Benchling In Vivo can Create API keys in API keys section under integrations in Manage teams (/team/integrations/api)

After clicking create API key, the administrator will name this key and select the relevant scope(s) before clicking create.

Next the client ID and secret key is generated and display which must be stored securely. This API key can be deleted and the client ID viewed but the Secret ID will not be available after clicking done in this step.


Using the API

When using the In Vivo API add the path of the API you would like to call to your tenant domain in the following format:

For production tenants : yourcompanyname-api.overwatchresearch.com

For sandbox tenants: yourcompanyname-sandbox-api.overwatchresearch.com

If you are unsure of your specific URL domain please contact support.

Listing all users with using the path api/public/v1/users


Enabling Webhooks

You can utilize Benchling In Vivo Webhooks to listen for events on your team so your integration can automatically trigger reactions. You will find the details of all available webhooks in the API Docs.

Please contact support to request the Webhook to be enabled for any available events as listed in the API Docs below.


Download API Docs

API version: v2022-12-14

 

Was this article helpful?

Have more questions? Submit a request