> ## Documentation Index
> Fetch the complete documentation index at: https://docs.platform.neural-motion.org/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Create a PAT, install nmp, and make your first API call in a few minutes.

<Steps>
  <Step title="Create a personal access token">
    1. Sign in to the [platform console](https://platform.neural-motion.org).
    2. Open **Settings → API tokens**.
    3. Create a token.

    <Warning>
      Copy the `nmp_…` secret when it appears — it is shown only once.
    </Warning>

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

  <Step title="Install the CLI">
    From a checkout of this repository:

    <CodeGroup>
      ```bash uv theme={null}
      uv tool install ./clients/python
      ```

      ```bash pipx theme={null}
      pipx install ./clients/python
      ```
    </CodeGroup>
  </Step>

  <Step title="Authenticate">
    Use the **same channel** where you created the PAT. Production tokens `401`
    against the dev host, and vice versa.

    ```bash theme={null}
    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:

    ```bash theme={null}
    export NMP_API_TOKEN=nmp_…
    export NMP_BASE_URL=https://platform.neural-motion.org
    nmp whoami --json
    ```

    <Note>
      To target the [dev channel](https://dev.platform.neural-motion.org),
      create the PAT in that console and set
      `NMP_BASE_URL=https://dev.platform.neural-motion.org`.
    </Note>
  </Step>

  <Step title="Browse catalog and project data">
    ```bash theme={null}
    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
    ```
  </Step>

  <Step title="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:

    ```bash theme={null}
    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 .
    ```

    <Check>
      A JSON body with your user profile means the token and base URL are
      wired up correctly.
    </Check>
  </Step>
</Steps>

## Next steps

<CardGroup cols={2}>
  <Card title="Authentication" icon="key" href="/authentication">
    Scopes, token lifecycle, and Clerk sessions vs PATs.
  </Card>

  <Card title="API reference" icon="code" href="/api-overview">
    Every published endpoint, with an interactive playground.
  </Card>
</CardGroup>