Authentication

To authenticate with the public API, you must first generate an API key. You can generate an API key by going to Settings -> API and pressing the Generate button.

IMPORTANT: Your API keys grant access to your data, so please keep them secure.

It is highly recommended you also turn on copyable ids. You can do this by ensuring the checkbox is enabled.

Once you have an API key, you can verify it is working using the following endpoint.

Verify API key

GET https://app.biodock.ai/api/external/check

Headers

Name	Type	Description
X-API-KEY*	String	API key.

200: OK Request was processed successfully

{
    user: "auth0|1234567890",
    email: "[email protected]",
    messsage: "API key is valid."
}

Sample Usage

import requests

API_KEY = "" # Replace with your api key
URL = "https://app.biodock.ai/api/external/check"

headers = {"X-API-KEY": API_KEY, "Content-Type": "application/json"}

response = requests.get(URL, headers=headers)
print(response.text)