Getting Started

API Keys

Create and manage API keys to authenticate with the Notery REST API and MCP server.

Overview

API keys are required to authenticate requests to the Notery REST API and MCP server. Each key is scoped to a single workspace and grants read access to all documents within it.

Creating an API Key

Open your workspace and navigate to the Settings page.
Find the API Keys section.
Click Create API Key and give it a descriptive name (e.g. claude-code, ci-pipeline).
Copy the generated key immediately.

API keys are shown only once at creation. If you lose a key, revoke it and create a new one.

Key Format

All Notery API keys use the ntry_ prefix:

ntry_a1b2c3d4e5f6...

This makes it easy to identify Notery keys in your environment and to set up secret scanning rules in your repositories.

Usage

Pass your API key in the Authorization header as a Bearer token:

curl -H "Authorization: Bearer ntry_your_key_here" \
  https://notery.app/api/v1/search?q=deployment

This applies to all /api/v1/* endpoints and to the MCP server connection.

Security

Treat API keys like passwords. A leaked key grants read access to every document in the workspace.

Store keys in environment variables — never hardcode them in source files.
Never commit keys to git — add .env to your .gitignore and use .env.example for placeholders.
Rotate keys periodically — revoke old keys and create new ones on a regular schedule.

# .env
NOTERY_API_KEY=ntry_your_key_here

Managing Keys

You can create multiple API keys per workspace. Each key can be independently revoked from the Settings page without affecting other keys.

Revoking a Key

Go to Settings > API Keys.
Find the key you want to revoke.
Click Revoke and confirm.

Revoked keys stop working immediately. Any tools or integrations using that key will need to be updated with a new one.

Use separate keys for different tools and environments. This way you can revoke access for a single integration without disrupting others.