Authentication
To interact with the Encord platform, you need to authenticate. Please, follow these steps:
- Ensure that you have an Encord account. If you don't, you can register here.
- Follow this documentation to obtain a public and private ssh key.
💡 Consider creating a service accounte for the purpose of creating agents.
- In the environment that you plan to run your agents, set either of these two environment variables:
ENCORD_SSH_KEY
: Containing the raw private key file contentENCORD_SSH_KEY_FILE
: Containing the absolute path to the private key file
If none of the env variables are set, the code will cast a pydantic validation error the first time it needs the ssh key.
ℹ️ Effectively, this part of the
encord
SDK is used to perform authentication.