Quick start

Create a project and make your first authenticated API call in a few minutes.

Prerequisites

A LocalMind account (sign in here) — sign-in is passwordless (email code, passkey, or Google / GitHub).

Step 1: Create a project

Sign in to the dashboard, click Create project, and give it a name and slug. You become the project's Owner automatically.

Step 2: Mint a scoped API key

In Project settings → API keys, create a key and choose the exact permissions it should carry (for example project:read and members:read). The key is shown once — copy it now. It is frozen to this project and can never exceed the permissions you selected.

Step 3: Call the API

Shell

curl https://api.localmind.app/api/v1/projects \
  -H "Authorization: Bearer $LOCALMIND_API_KEY"

JSON

{
  "data": [{ "id": "…", "name": "Acme Platform", "slug": "acme-platform" }],
  "meta": { "timestamp": "2026-07-24T09:00:00.000Z" }
}

Every response uses the same { data, meta } envelope; errors use { statusCode, errorCode, message } with a stable machine-readable errorCode.

Step 4: Subscribe a webhook

Add an endpoint under Project settings → Webhooks, choose the events you care about (for example member.added), and verify the HMAC signature on each delivery — see Webhooks.

Next steps