Skip to Content
SettingsAPI Keys

API Keys Settings

Use API Keys to create and manage keys for integrations, public API access, and embedded job workflows.

API keys settings dialog

Create an API Key

  1. Open Settings.
  2. Select API Keys.
  3. Click Create New Key.
  4. Enter a name, validity period, optional description, and embed token setting.
  5. Click Create API Key.
FieldDescriptionRequired
NameClear key name, 3 to 50 characters.Yes
Valid ForExpiration period: 15 days, 25 days, 45 days, 90 days, 6 months, or 1 year.Yes
DescriptionOptional note explaining what the key is for. Maximum 500 characters.No
Generate embed tokenCreates an embed token with the key for job embed use cases.No

Manage Keys

ActionDescription
CopyCopies a visible key value.
DeleteRevokes the key. Connected integrations using that key will stop working.