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.

All keys are prefixed with sk-som-. A key is not itself a credential you send on API calls — you exchange it for a short-lived JWT first, as described in Authentication.

Key types

User API key

Inherits the permissions of the user who created it. Use when an integration must act as a specific user. Limited to 5 per 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.

Workspace and organisation keys carry a role, which you pick when creating the key. The role caps what the key can do, using the same roles described in User Roles & Workspaces — so a read-only integration should be issued a Viewer key rather than an Editor one.

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.

Rotating a key

You do not have to delete a key and rebuild the integration to change its secret. Rotating a key issues a new secret and invalidates the previous one, keeping the key’s name, scope and role intact — so you can roll credentials on a schedule, or immediately if one leaks.

Rotation is available from the same API panel where you created the key, and through the API Key endpoints in the API Reference.

Rotation takes effect immediately. Any integration still holding the old secret will start receiving 401 responses, so update your secret store first.

Best practices

• Treat API keys like passwords — never share them publicly.
• Prefer the narrowest scope that works: a workspace key over an organisation key, and a Viewer role over an Editor one.
• Rotate keys regularly and delete 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.