API Keys

Console

API Keys

API Keys provide secure access to the API endpoints.

While you can create and monitor Jobs directly through the console without an API key, you’ll need an API key to:

  • Call API endpoints directly from your applications or scripts.
  • Download a Job output

Creating a New API Key

To generate a new key:

  1. Proceed with clicking on Create API Key on the console.
  2. Provide a name and description (optional) for quick recognition.
  3. Select an expiration time from the dropdown menu. Be mindful while setting the expiration date as the key will automatically expire after this date and cannot be used.
  4. Added IP address restrictions (Enterprise customers only) to enhance security by whitelisting specific IP addresses that are authorized to use this API key.
    • This prevents unauthorized access even if your API key is compromised, as requests from non-whitelisted IPs will be automatically rejected.
    • This feature is particularly important for enforcing IP restrictions on different environments and compliance requirements.
    • Limit: Up to 5 IP addresses can be added per API key.
  5. Configure permissions (scopes) to control what the key can access.
    • Available scopes include:
      • Create a Job
      • Get Job Status
      • Get Job Output
      • Upload File
      • Get Presigned URL
  6. Once the API Key is created, the user will be provided a Client ID and a Client Secret. Make sure to save the Client Secret as it will only be shown once, during creation.
  7. These keys can now be used to send requests to the API.

Note that each member of the organization can generate at most 10 API Keys, after which the previous keys must be deleted to create new ones.

Viewing API Keys

The API Keys page displays a complete list of keys associated with your organization.

For each key, you can see:

  • Client ID - client identifier of the API Key.
  • Name & Description - user-defined labels for easy identification.
  • Created By - the email of the user who generated the key.
  • Created At - the timestamp at which the API Key was created.
  • Expiration Date - the date after which the key will no longer be valid.

Keys are listed in reverse chronological order, with the most recently created keys appearing first.

Managing API Keys

If the user would like to delete the API key, click the Delete button to revoke access immediately.

Once deleted, a key can no longer be used to send requests.