2. Authentication Basics

To authenticate with Encord you must register a public key in the Encord platform. See our documentation here to learn more. Users can only access Projects, Datasets, and Ontologies from within their Workspace.

Authentication must occur every time an SDK script is run.

Ensure your private key is not password protected. All private keys generated on the Encord platform as described in our documentation are not password protected by default.

After registering a public key, use the corresponding private key to authenticate your EncordUserClient. The following code sample needs to be included in all SDK interactions, and hence is included in all code snippets we provide in these tutorials.

We recommend using the file path to your private key, rather than the private key itself when authenticating.

The following script must be added to all Encord SDK scripts. It is present in all complete code examples we provide.

# Import dependencies
from encord import EncordUserClient

# Authenticate with Encord using the path to your private key
user_client = EncordUserClient.create_with_ssh_private_key(
    ssh_private_key_path="<private_key_path>"
    )

# Import dependencies
from encord import EncordUserClient

# Authenticate with Encord using the path to your private key
user_client = EncordUserClient.create_with_ssh_private_key(
    ssh_private_key_path="/Users/chris-encord/sdk-ssh-private-key"
    )

US Customers

If you are using Encord’s US based hosted platform, ALL authentication for the SDK MUST include the following:

domain="https://api.us.encord.com"

# Import dependencies
from encord import EncordUserClient

# Authenticate with Encord using the path to your private key
user_client = EncordUserClient.create_with_ssh_private_key(
    ssh_private_key_path="<private_key_path>",
    domain="https://api.us.encord.com",
)

# Import dependencies
from encord import EncordUserClient

# Authenticate with Encord using the path to your private key
user_client = EncordUserClient.create_with_ssh_private_key(
    ssh_private_key_path="/Users/chris-encord/sdk-ssh-private-key",
    domain="https://api.us.encord.com",
    )

1. Prerequisites and Installation Import/Register Data (SDK)

​US Customers

US Customers