The API Keys page offers you a convenient way to manage authentication for API calls, enabling secure access to platform functionalities. Here, you can create and manage API keys, customize their scopes to restrict access, and securely store their secret keys for future use.

Creating API Keys

Create api key

To create a new API key and customize its scopes, follow these simple steps:

  1. Navigate to API Keys: Access the API Keys page within your workspace. This can typically be found within the Workspace Settings or a dedicated API Keys tab.

  2. Click “Add New Key”: Look for the “Add New Key” button and click on it to initiate the key creation process.

  3. Fill in Details: In the modal form that pops up, provide the necessary details for the new API key:

    • Name: Enter a descriptive name for the API key to easily identify its purpose or usage.
    • Scope: Choose the appropriate scope for the API key.
  4. Generate Key: After filling in the details, proceed to generate the API key by clicking the “Generate Key” button.

  5. Copy Secret Key: Once the API key is generated, a secret key will be generated as well. Copy this secret key and store it securely in a safe location. This secret key will be used to authenticate API calls.

API Key Scopes

  • Project: Provides access to manage projects, upload datasets, train models, and make predictions.
  • Inference: Provides access to make inferences on trained models. Can be used for public access to the models.

Managing API Keys

Once created, you can manage your API keys effortlessly:

  • Edit Scopes: If needed, you can edit the scopes of an existing API key to adjust its access permissions.
  • Delete Key: If an API key is no longer needed or compromised, you can delete it by clicking on the trash icon next to the respective key.

Best Practices

To ensure the security of your API keys and the integrity of your workspace, consider the following best practices:

  • Store Securely: Always store API keys securely in a safe and accessible location. Avoid sharing them publicly or exposing them in plaintext.
  • Rotate Regularly: Rotate API keys periodically to mitigate the risk of unauthorized access or misuse.
  • Scope Appropriately: Assign scopes to API keys based on the principle of the least privilege, granting only the necessary access permissions required for their intended use.

By following these guidelines, you can effectively manage API keys within your workspace, maintain security, and control access to platform functionalities. Should you have any questions or need assistance with API key management, our support team is available to provide guidance and support. We’re committed to ensuring a secure and seamless experience for all users.