Encord currently supports hosting your platform instance globally or in the US. The Global and the US instances have complete feature parity with each other. The major differences are the following:

  • Global and US instances are completely independent of each other.

  • Global instance users access the Encord platform using https://app.encord.com/.

  • US instance users access the Encord platform using https://app.us.encord.com/.

  • Using the SDK with the US instance requires adding domain="https://api.us.encord.com" to their code for authentication.

Authentication with US instances

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"

Examples

All templates in the documentation work for both the US and Global deployments. While the examples below use the US deployment for clarity, you can adapt any SDK template to the US deployment by simply updating the domain parameter in the authentication call, even if a US-specific example is not provided.

The US templates MUST include domain for authentication:

user_client = EncordUserClient.create_with_ssh_private_key(
    ssh_private_key_path=SSH_PATH,
    domain="https://api.us.encord.com"
)