Quickstart

From zero to your first authenticated API call

This guide takes you from a fresh account to your first authenticated request in about five minutes.

1. Sign in

Open the Share Of Model console and sign in. If you do not have an account yet, contact your account manager via the Talk to us page.

2. Create an API key

In the console, navigate to your workspace settings and create an API key. Keys are prefixed with sk-som-. Copy the secret immediately — you will not see it again.

3. Exchange the key for a JWT

API endpoints expect a Bearer JWT, not the raw API key. Exchange the key for a token:

curl -X POST https://api.shareofmodel.ai/v1/auth/token \
  -H "Content-Type: application/json" \
  -d '{"secret_key": "<YOUR_API_KEY>"}'

The response is a single field — treat the token as short-lived:

{ "token": "<ACCESS_TOKEN>" }

4. Make your first call

List the organisations your token can access:

curl https://api.shareofmodel.ai/v1/organizations \
  -H "Authorization: Bearer <ACCESS_TOKEN>"

Take an id from the response and list its workspaces — most endpoints are scoped by organisation and workspace:

curl https://api.shareofmodel.ai/v1/organizations/<ORGANIZATION_ID>/workspaces \
  -H "Authorization: Bearer <ACCESS_TOKEN>"

You are up and running. From here, head to the API Reference to explore every endpoint, or read Authentication for the full auth picture.