Creating and Managing API Keys

Create user, workspace, and organisation API keys to securely connect external tools to Share Of Model.

API keys let you connect external tools or integrations securely to your account. Three key types exist, each with distinct permissions and creation requirements.

Key types

User API key

Inherits the permissions of the user who created it. Use when an integration must act as a specific user.

Workspace API key

Created by users with the Workspace Editor role. Grants API access to a single workspace.

Organization API key

Created by Organization Owners. Grants API access across the entire organisation.

How to create API keys

User API key

Use this when an integration should act as you.

1. Open your profile

   Click your profile icon in the bottom-left corner, then click your name.

2. Go to API Keys

   Open the API Keys section.

3. Create the key

   Click Create API Key and enter a name.

4. Copy the key now

   Copy the key immediately — it will not be visible again later.

Workspace API key

Use this for workspace-level integrations.

You must have the Workspace Editor role (or higher) to create a workspace API key.

1. Open Settings

   Click your profile icon in the bottom-left, then click Settings.

2. Pick the workspace

   Select the workspace you want to manage.

3. Open the API section

   Open API in the left panel. (If you see Workspace Settings instead of Settings, click that — it leads to the same place.)

4. Create the key

   Click Create API Key and enter a name.

5. Copy the key now

   Copy the key immediately — it will not be visible again later.

Organization API key

Use this for organisation-wide integrations.

You must be an Organization Owner to create an organisation-level API key.

1. Open Settings

   Click your profile icon in the bottom-left, then click Settings.

2. Open the API section

   Open API in the left panel.

3. Create the key

   Click Create API Key and enter a name.

4. Copy the key now

   Copy the key immediately — it will not be visible again later.

Best practices

• Treat API keys like passwords — never share them publicly.
• Rotate keys regularly and revoke unused ones.
• Store them in a secret manager or environment variable, not in source code.

What’s next

API Documentation Guide

Use your key to make your first call.

MCP Server Setup

Connect AI assistants to Share Of Model.