> ## Documentation Index
> Fetch the complete documentation index at: https://supermemory-capy-add-llmstxt-summary-and.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# API keys & auth

> Org API keys, container-scoped keys, and connector branding.

## API keys

All API requests require authentication using a Bearer token. Get your API key from the [Developer Platform](https://console.supermemory.ai).

<Snippet file="getting-api-key.mdx" />

Include your key in all requests:

<CodeGroup>
  ```bash cURL theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
  curl https://api.supermemory.ai/v3/search \
    --header 'Authorization: Bearer YOUR_API_KEY' \
    --header 'Content-Type: application/json' \
    -d '{"q": "hello"}'
  ```

  ```typescript TypeScript theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
  import Supermemory from "supermemory";

  const client = new Supermemory({ apiKey: "YOUR_API_KEY" });
  ```

  ```python Python theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
  from supermemory import Supermemory

  client = Supermemory(api_key="YOUR_API_KEY")
  ```
</CodeGroup>

***

## Connector branding

When users connect external services (Google Drive, Notion, OneDrive), they see a "Log in to **Supermemory**" prompt by default. You can replace this with your own app name by providing your own OAuth credentials via the settings endpoint.

```typescript theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
await client.settings.update({
  googleDriveCustomKeyEnabled: true,
  googleDriveClientId: "your-client-id.apps.googleusercontent.com",
  googleDriveClientSecret: "your-client-secret"
});
```

This works for Google Drive, Notion, and OneDrive. See the full setup in [Customization](/concepts/customization).

***

## Scoped API keys

Scoped keys are restricted to one or more `containerTag`s. They can only access documents and search within those containers — use them to give a client, session, or tenant limited access without shipping your org master key.

Pairs with [container tags](/concepts/container-tags) for multi-tenant isolation.

**Allowed endpoints:** `/v3/documents`, `/v3/memories`, `/v4/memories`, `/v3/search`, `/v4/search`, `/v4/profile`

Scoped keys **cannot** read billing, manage org settings, or mint further keys.

### Create a scoped key

```bash theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
curl https://api.supermemory.ai/v3/auth/scoped-key \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  -d '{
    "containerTag": "my-project",
    "name": "my-key-name",
    "expiresInDays": 30
  }'
```

### Parameters

| Parameter | Required | Default | Description |
| - | - | - | - |
| `containerTag` | Yes | — | Alphanumeric, hyphens, underscores, colons, dots |
| `name` | No | `scoped_{containerTag}` | Display name for the key |
| `expiresInDays` | No | — | 1–365 days |
| `rateLimitMax` | No | `500` | Max requests per window (1–10,000) |
| `rateLimitTimeWindow` | No | `60000` | Window in milliseconds (1–3,600,000) |

### Response

```json theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
{
  "key": "sm_orgId_...",
  "id": "key-id",
  "name": "scoped_my-project",
  "containerTag": "my-project",
  "expiresAt": "2026-03-08T00:00:00.000Z",
  "allowedEndpoints": ["/v3/documents", "/v3/memories", "/v4/memories", "/v3/search", "/v4/search", "/v4/profile"]
}
```

Use the returned key like a normal API key — it just will not work outside its container scope.

### Disable a scoped key

Revoke with the `id` from creation. Subsequent requests get `401`. Memories and container tags are **not** deleted.

```bash theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
curl https://api.supermemory.ai/v3/auth/scoped-key/KEY_ID \
  --request DELETE \
  --header 'Authorization: Bearer YOUR_API_KEY'
```

```json theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
{ "success": true }
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.