Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.nudgen.net/llms.txt

Use this file to discover all available pages before exploring further.

Nudgen now supports developer access through Personal Access Tokens (PATs). Use the same token for the REST API, the MCP server, and agent workflows.

​
Why this matters

You can connect Nudgen to scripts, internal tools, and AI agents without sharing your dashboard login. Tokens are scoped to your account and active workspace, and every request is still protected by Nudgen rate limits and workspace permissions.

​
Create an API key

  1. Open nudgen.net.
  2. Go to Settings -> API Keys.
  3. Create a Personal Access Token.
  4. Copy the token once and store it securely.
Use the token in the standard bearer header: 
Authorization: Bearer pat_...

​
REST API

Use the REST API when you want conventional HTTP endpoints for contacts, campaigns, brand settings, and AI draft generation. 
curl https://nudgen.net/api/v1/user/me \
  -H "Authorization: Bearer <your-pat>"
Common endpoints include:
MethodEndpointPurpose
GET/api/v1/user/meGet the authenticated user.
GET/api/v1/contactsList contacts in the active workspace.
POST/api/v1/contacts/addCreate a contact.
GET/api/v1/campaignsList campaigns.
POST/api/v1/campaignsCreate a campaign.
POST/api/v1/campaigns/:id/launchLaunch or schedule a campaign.
GET/api/v1/campaigns/:id/statsRead campaign stats.
GET/api/v1/settings/brandRead brand settings.
PATCH/api/v1/settings/brandUpdate brand settings.
POST/api/v1/ai/generateGenerate an email draft.

​
MCP server

Use MCP when an AI agent can call tools directly instead of hand-coding REST requests. The MCP endpoint is: 
https://nudgen.net/api/mcp
The server card is available at: 
https://nudgen.net/.well-known/mcp/server-card.json
MCP uses the same bearer PAT as the REST API.

​
Safety notes

  • Treat PATs like passwords.
  • Revoke tokens from Settings -> API Keys when they are no longer needed.
  • Campaign launch endpoints can send real email when the worker processes the queue.
  • Use future scheduledAt values for tests when you do not want to send immediately.