Skip to main content

How to create an API key

API keys allow you to securely connect LingoHub to external tools, scripts, and automated workflows. To keep your workspace secure, LingoHub uses a granular permission system and flexible scope options for every key.

Accessing API keys

You can access and create API keys from the Workspace menu:

  1. Click your Workspace icon in the top-left corner.

  2. Select API keys.
    ​

  3. Click the + Create new API key button.
    ​

💬 Please note: Creating API keys from the Workspace administration menu can only be done by workspace owners or admins.

API key creation wizard

General information & scope selection

In the first step of the creation wizard, define the key's identity and select its operational scope:

  • Name: Enter a clear identifier.

  • Description (Optional): Add context regarding the key's intended tool or purpose.

  • Expiration date (Optional): Set an automatic expiration date to enforce security compliance.
    ​

  • Scope: Select one of the following three scopes depending on your access requirements: Workspace, Stack, Member

Available API key scopes

1. Workspace scope

  • Behavior: Operates across the entire workspace and all projects/stacks within it.
    ​

  • What you see next in the wizard:

    • Proceed directly to Workspace permissions to configure global access (e.g., Administration, Members, Plugins & Integrations, Logs, API Access).
      ​

    • Then proceed to Project permissions to set default project-level access levels.
      ​

2. Project/Stack scope

  • Behavior: Belongs exclusively to a single stack/project and only reaches that stack's resources. A Stack key is automatically deactivated if its associated stack is deleted.
    ​

  • What you see next in the wizard:

    • Moves to an Access step where you select the specific stack from a dropdown menu.
      ​

    • You proceed directly to Project permissions to configure granular permissions (e.g., Languages, Settings, Activities, Resources) for that specific stack.
      ​

3. Member scope

  • Behavior: Belongs to a specific member of the workspace (=Admin-managed key for a user). A member key is automatically deactivated if that member is removed from the workspace.
    ​

  • What you see next in the wizard:

    • Moves to an Access step where you select the target member from a dropdown list.
      ​

    • Proceed through both Workspace permissions and Project permissions to define the exact permissions assigned to this user key.
      ​


Configuring permission levels

For steps covering Workspace or Project permissions, select the desired access level for each feature area:

Access level

Description

No access

The item is fully restricted and cannot be viewed via the API.

View only

The item can be retrieved/viewed, but not modified.

Full access

The item can be viewed and updated without limitation.

Summary and authentication

  1. Review the configuration summary (General information, Scope, Access target, and active Permissions).
    ​

  2. Click Save.

  3. In the authentication pop-up, enter your user account Password to confirm your identity.

  4. Click Create new API key.
    ​
    ⚠️ Important: For security reasons, the full token string is displayed only once. After leaving or refreshing the page, you will no longer be able to view or reveal the token.
    ​

Looking for self-managed API keys?

Individual team members can create and delete self-managed API keys and inspect admin-managed ones assigned to them directly from their account settings:

  1. Click your User avatar in the top-right corner of LingoHub.

  2. Select API keys from the dropdown menu.
    ​

  3. Switch between the Self-managed and Admin-managed tabs to view active keys and assigned permissions.
    ​

Read more in our guide on how to create self-managed API keys.

Need more help?

Couldn't find what you were looking for? We are here to help! Reach out to our team at [email protected], and we will gladly assist you.

Did this answer your question?