Skip to main content

API keys

Connect scripts and tools to your account.

Create an API key when you want a script or tool to access the Hub on your behalf. The Embedl Hub SDK, CLI, and REST API use it to authenticate as your account, with your project permissions.

Create a key#

  1. Open API keys from your account.
  2. Enter a label describing its use, such as Evaluation workstation.
  3. Choose an Expiration period and select Create key.
  4. Copy and store the key securely. It is shown only once.

The account can have up to five active keys. Remove an unused key if you reach the limit.

Configure the SDK#

Use SDK setup to configure both the key and the address of this Hub. For automated jobs, store the key in your job runner’s secret store and provide it through EMBEDL_HUB_API_KEY.

Warning

Keep keys out of source code, screenshots, and logs. embedl-hub auth reports where the configured key comes from without printing its value.

Replace a key#

  1. Create a replacement key.
  2. Update the tools that use it and confirm they can connect.
  3. Revoke the old key from API keys.

Expired or revoked keys can no longer authenticate. If a key was exposed, revoke it immediately and replace it in affected tools.

Next steps#