Quickstart - NMotion Platform

Create a personal access token

Sign in to the platform console.
Open Settings → API tokens.
Create a token.

Copy the nmp_… secret when it appears — it is shown only once.

Tokens are created, listed, and revoked in the browser console only. The API rejects PATs on token-management endpoints.

Install the CLI

From a checkout of this repository:

uv tool install ./clients/python

pipx install ./clients/python

Authenticate

Use the same channel where you created the PAT. Production tokens 401 against the dev host, and vice versa.

nmp auth token set
# paste the nmp_… secret from the production console
nmp whoami --base-url https://platform.neural-motion.org --json

For CI or headless use, set environment variables instead:

export NMP_API_TOKEN=nmp_…
export NMP_BASE_URL=https://platform.neural-motion.org
nmp whoami --json

To target the dev channel, create the PAT in that console and set NMP_BASE_URL=https://dev.platform.neural-motion.org.

Browse catalog and project data

nmp version
nmp catalog datasets list --json
nmp orgs list --json
nmp projects list --org <org_slug> --json
nmp datasets list --org <org_slug> --project <project_slug> --json

Call the HTTP API directly

nmp auth token set stores the secret in the keyring/file store — it does not export NMP_API_TOKEN. For raw curl, paste the same secret into the environment:

export NMP_API_TOKEN=nmp_…   # the token you copied in step 1
export NMP_BASE_URL=https://platform.neural-motion.org

curl -sS \
  -H "Authorization: Bearer $NMP_API_TOKEN" \
  "$NMP_BASE_URL/api/v1/users/me" | jq .

A JSON body with your user profile means the token and base URL are wired up correctly.

Next steps

Authentication

Scopes, token lifecycle, and Clerk sessions vs PATs.

API reference

Every published endpoint, with an interactive playground.

⌘I

​Next steps

Authentication

API reference

Next steps