Neuron

Register a new user account with name, email, password, and organization name. Creates both the user and an initial organization.

Authenticate with Neuron. Three modes: 1. No args: Opens a browser URL for secure authorization (recommended — no credentials shared with AI) 2. token: Paste an MCP token from the Neuron dashboard 3. email+password: Legacy login (credentials visible to AI)

無需輸入參數。

Refresh the access token using a refresh token. Automatically sets the new access token for subsequent API calls.

Switch to a different organization. Returns a new access token scoped to the target organization and automatically sets it.

Retrieve all organizations the authenticated user belongs to, including their roles in each.

無需輸入參數。

Retrieve the authenticated user's profile information including name, email, role, and current organization.

無需輸入參數。

Check which Neuron account is currently logged in, including user name, email, role, and organization.

無需輸入參數。

Switch the MCP server to target a different Neuron backend instance. Auth tokens are preserved per instance — if you've previously logged in to an instance, switching back restores your session automatically. Call with no args to list known instances and see which is active.

Clear the current auth token locally. Does NOT revoke server-side MCP tokens — revoke from the Neuron dashboard (Settings > MCP Tokens) for full invalidation.

無需輸入參數。

Create a new AI bot with specified name, model, and behavior instructions. Returns the created bot object.

Retrieve all bots accessible to the current user, including their configurations and status.

無需輸入參數。

Retrieve detailed information about a specific bot including its configuration, status, and associated resources.

Update an existing bot's configuration. Only provided fields are modified; omitted fields remain unchanged.

Permanently delete a bot and all its associated data. This action cannot be undone.

Pause a bot to temporarily stop it from processing new messages. The bot retains its configuration and can be resumed later.

Resume a previously paused bot so it begins processing new messages again.

Retrieve analytics and usage statistics for a specific bot, including message counts, response times, and conversation metrics.

Attach a knowledge base to a bot to enhance its responses with domain-specific knowledge. Optional priority determines retrieval order when multiple knowledge bases are attached.

Retrieve all knowledge bases attached to a specific bot, including their priorities and metadata.

Remove a knowledge base from a bot. The bot will no longer reference this knowledge base when generating responses.

Create a new API key for programmatic access to a specific bot. Store the key securely as it cannot be retrieved later.

Retrieve all API keys associated with a specific bot, including their names, creation dates, expiration status, and revocation status.

Permanently revoke an API key to immediately invalidate it and prevent further programmatic access. This action cannot be undone.

Send a message to a bot via the API and receive a streaming or complete AI-generated response. Requires a valid API key with 'nrn_' prefix.

Send an outbound message through the bot API to a specified phone number. Supports text and media messages. Requires a valid API key.

Retrieve a paginated list of conversations managed by the bot. Supports filtering by conversation status. Requires a valid API key.

Retrieve message history for a specific conversation with cursor-based pagination. Requires a valid API key.

Retrieve configuration and status information about the bot associated with the provided API key.

Retrieve a paginated list of conversations for a specific bot, with optional filtering by status.

Retrieve detailed information about a specific conversation, including its status, participants, and metadata.

Retrieve messages from a specific conversation in chronological order, with optional cursor-based pagination.

Transfer control of a conversation from the bot to a human agent. The bot will stop auto-responding until the conversation is released.

Release a conversation back to the bot, returning control from a human agent. The bot will resume auto-responding.

Send a message to an existing conversation. Supports text, image, and document message types with optional media attachments.

Compose and send a new message to a phone number via a specific channel. Automatically creates a new conversation if one does not exist.

Send a WhatsApp message to a phone number or group. Auto-resolves which channel to use (org default > first connected). Supports text, image, audio, video, and document types.

Edit the content of a previously sent message in a conversation. Only the message sender can edit their messages.

Permanently delete a specific message from a conversation. This action cannot be undone.

Close an active conversation, marking it as completed. The bot will stop responding and the conversation is archived.

Create a new knowledge base to store and organize information, documents, and entries.

Retrieve all knowledge bases accessible to the current user.

無需輸入參數。

Retrieve detailed information about a specific knowledge base by its ID.

Update the properties of an existing knowledge base such as name, description, or root instruction.

Permanently delete a knowledge base and all its associated entries and documents.

Add a new entry (note, document, or information piece) to a knowledge base.

Retrieve entries from a knowledge base with optional filtering and pagination.

Update the content, title, folder, or source of an existing knowledge base entry.

Permanently delete a specific entry from a knowledge base.

Upload a text document to a knowledge base. The document will be automatically chunked and indexed for semantic search.

Perform semantic search across all entries and documents in a knowledge base to find relevant information.

Retrieve all bots that are connected to or using a specific knowledge base.

Ingest content into a knowledge base. Supports deduplication via externalId and optional LLM processing (summarize, extract_facts, or custom instruction).

Trigger a synchronization operation to refresh embeddings, reindex content, or update the knowledge base state.

Read a WhatsApp 'Export chat' (.txt, without media) and save the listings in it (trips, items for sale, services, jobs...) as entries that expire on their own date. Runs in the background: poll neuron_get_kb_import_status. Pro plan and up; charged to AI credits; reads at most the newest 1,000 messages from the last `sinceDays` days. The file itself is never stored. One import per organization at a time.

Progress of a WhatsApp chat import: state (queued/running/done/stopped/failed), messages read, listings created/updated, listings skipped because their date had passed.

How many knowledge bases, entries and characters the organization holds, against its plan's caps (maxBases, maxEntries, maxChars) and whether it can fill knowledge bases automatically.

無需輸入參數。

Create a custom API tool that the bot can invoke during conversations to fetch external data or trigger actions.

Retrieve all custom API tool integrations configured for a specific bot, including their endpoints and configuration.

Modify an existing custom API tool's configuration, including its endpoint, authentication, or request template.

Permanently remove a custom API tool integration from a bot. The bot will no longer be able to invoke this tool in conversations.

Execute a dry-run test of a custom API tool with sample arguments to verify the endpoint responds correctly.

Store or update a secret credential (API key, token, etc.) for a custom tool integration. Secrets are encrypted at rest.

Permanently delete a stored secret from a custom tool integration. The tool will lose access to this credential.

List all scheduled tasks for a bot. A task is a natural-language instruction the bot carries out autonomously on a schedule (e.g. 're-engage stale contacts every morning at 8am').

Create a scheduled autonomous task for a bot. The instruction is a self-contained, natural-language directive the bot executes with its tools (find stale conversations, message contacts, schedule follow-ups, etc.). Sends are always screened against Do-Not-Contact, a per-run cap, and a no-repeat window.

Update a scheduled task's instruction, schedule, timezone, enabled state, or config. Only provided fields change.

Delete a scheduled task. This is a soft delete — the task stops running immediately.

Pause or resume a scheduled task (flips its enabled state and reschedules the next run).

Trigger a task to run immediately (in addition to its normal schedule). Returns once the run is queued.

Retrieve the paginated execution history for a task — each run's status, AI summary, tool steps, and stats (messages sent, contacts processed).

Turn a plain-English description into a structured task spec (title, instruction, scheduleKind, schedule, timezone, config) WITHOUT creating it. Use the returned draft as input to neuron_create_task after any edits.

List configured lead sources for the org.

無需輸入參數。

Create a lead source. `config` depends on type: text_paste {text}; web_scrape {url|urls[]}; document {mediaUrl,mimeType}; tool_output {toolId,args?}; instagram/x {channelId, query?|hashtag?, limit?}; csv {rows[]}; stream {triggerTaskId?} (fed by the ingest endpoint). Set scheduleKind cron/interval/once for recurring (schedule: cron {time,days?} / interval {everyMinutes} / once {runAt}).

Run a lead source now to pull new leads into the pool (queues the extraction).

Run a one-off extraction WITHOUT creating a persistent source, saving the results to the lead pool. Great for pasted text or a web page. `type` + `config` as in neuron_create_lead_source (e.g. type='text_paste', config={text}).

List leads from the pool, filterable by status (new/enriched/contacted/converted/rejected), sourceId, and search.

Counts of leads by status.

無需輸入參數。

Promote a phone-bearing lead into a contact (so it can be messaged / added to lists). Optionally add the new contact to a list.

List voice personas for the org. Each persona holds a voiceProfile (tone/style/themes/dos/donts) + exemplars distilled from a Collection of mined content.

無需輸入參數。

Get one voice persona (full voiceProfile + exemplars).

Distill a reusable voice from a Collection of mined content: analyzes the top-engagement items and reverse-engineers a voiceProfile (tone, diction, cadence, emoji/formatting habits, themes, dos/donts) + representative exemplars. Requires the collection to have >=3 usable samples. Runs an LLM call (a few seconds).

Distill a reusable voice from raw text — no Collection or browser extension needed. Feed it pasted posts, a chat/dialogue transcript, WhatsApp-export text, or your own well-crafted writing sample, and it reverse-engineers a voiceProfile (tone, diction, cadence, emoji/formatting habits, themes, dos/donts) + exemplars. Provide `text` (auto-split into samples) and/or `samples` (already-split). Runs an LLM call (a few seconds).

Distill a reusable voice from an existing WhatsApp conversation's stored messages — no extension needed. `author` picks whose voice: 'me' (owner's own outgoing texts), 'contact' (the other party), 'bot', or 'any'. For a group chat, pass senderName/senderPhone to isolate one participant. Requires >=3 usable text messages. Runs an LLM call.

Generate content written in the persona's voice for a topic/brief. Returns N variations. Stateless — nothing is persisted.

Give a bot this persona's voice: merges a delimited voice block into the bot's system prompt (idempotent — re-applying or swapping personas replaces it cleanly) and tags the bot's metadata with the persona id.

Update a persona's name/description, or hand-tune its voiceProfile / exemplars.

Delete a voice persona.

Register a new inbound webhook endpoint that triggers bot actions when called by an external service.

Retrieve all inbound webhooks configured for a specific bot, including their status and configuration.

Modify an existing inbound webhook's configuration, such as its name, event type, or processing prompt.

Permanently remove an inbound webhook from a bot. External services will no longer be able to trigger this endpoint.

Retrieve execution logs for an inbound webhook to monitor incoming requests and debug processing issues.

Retrieve pending reflections that the bot has generated from conversations, awaiting human review. Optionally filter by approval status.

Approve a bot-generated reflection to incorporate the learned insight into the bot's future behavior and responses.

Reject a bot-generated reflection to prevent it from being incorporated into the bot's learned behavior.

Synchronize all approved reflections into the bot's active knowledge base, applying learned insights to future conversations.

Retrieve all WhatsApp channels configured in the current organization, including their type and connection status.

無需輸入參數。

Create a new WhatsApp channel with either Meta Cloud API or Baileys (direct WhatsApp) integration. Meta Cloud channels require metaPhoneNumberId and metaAccessToken.

Retrieve detailed information about a specific WhatsApp channel, including its configuration, type, and connection status.

List message templates on an official WhatsApp Business API session (provider 'meta'). On the official API you can only send free-form messages to someone who messaged you in the last 24 hours; outside that window only an approved template is delivered. Use a template's name + language with neuron_send_whatsapp / neuron_compose_message / neuron_create_broadcast (messageType 'template').

Update configuration of an existing WhatsApp channel. Only provided fields are modified; omitted fields remain unchanged.

Permanently delete a WhatsApp channel and disconnect any active sessions. This action cannot be undone.

Assign a bot to handle incoming messages on a specific WhatsApp channel. Replaces any previously assigned bot.

Remove the bot assignment from a WhatsApp channel. The channel will stop auto-responding to messages.

Start a Baileys (direct WhatsApp) session for the channel. Generates a QR code for device pairing. Only applicable to Baileys-type channels.

Stop the active Baileys session for the channel and disconnect from WhatsApp. The channel can be restarted later.

Retrieve the current connection status and session details for a specific channel (e.g., connected, disconnected, qr_pending).

Request a numeric pairing code for a Baileys channel as an alternative to QR code scanning. Requires the phone number to pair with.

Retrieve all WhatsApp groups that the channel is participating in, including group metadata.

Retrieve the list of participants in a specific WhatsApp group accessible through a channel.

Retrieve contacts from the WhatsApp account connected to this channel, with optional search filtering.

Retrieve the event log for a channel, including connection events, message events, and errors. Supports pagination.

Retrieve the current QR code for pairing a Baileys channel with WhatsApp. A session must be started first.

Retrieve all WhatsApp channels connected to a specific bot, including primary and secondary connections.

Connect an additional WhatsApp channel to a bot as a secondary number. The bot will respond to messages on this channel.

Disconnect a WhatsApp channel from a bot. The bot will no longer respond to messages on this channel.

Browse the shared marketplace pool of published bots, tools, knowledge bases, and reflections with optional filtering by type, category, tags, or search query.

Retrieve detailed information about a specific item in the marketplace pool, including its description, category, tags, and install count.

List all items the current organization has published to the marketplace pool.

無需輸入參數。

List all items the current organization has installed from the marketplace pool.

無需輸入參數。

Publish a bot, tool, knowledge base, or reflection to the shared marketplace pool for other organizations to discover and install.

Update a pool item you have published — metadata (name, description, category, tags) and content fields (setupInstructions, defaultSecrets for tool_template items). The underlying resource is re-snapshotted and version is bumped on every update.

Permanently remove a published item from the marketplace pool. Organizations that installed this item will retain their copies.

Install a resource from the marketplace pool into the current organization. Choose 'fork' for an independent copy or 'subscribe' to receive future updates from the publisher.

Pull the latest updates for a subscribed pool resource to sync with the publisher's changes. Only applies to items installed with 'subscribe' mode.

Toggle the featured status of a pool item. Featured items appear prominently in the marketplace. Requires admin privileges.

Retrieve detailed information about a specific organization, including its name, settings, and configuration.

Update organization settings such as name, description, or configuration preferences. Only provided fields are changed.

Update WhatsApp Business API credentials for the organization. These credentials are required for sending messages via the WhatsApp Cloud API.

Set or clear the default WhatsApp channel for the organization. The default channel is used by neuron_send_whatsapp for auto-resolving which channel to send through.

Retrieve a list of all members in the organization, including their roles and permissions.

Send an invitation to a new member to join the organization. The invitee receives an email with a link to accept.

Retrieve a list of all pending invitations for the organization that have not yet been accepted or revoked.

Revoke a pending organization invitation so it can no longer be accepted. This action cannot be undone.

Update a member's permissions within the organization, such as conversation access. Only provided fields are changed.

Permanently remove a member from the organization. The member loses all access immediately. This action cannot be undone.

Who the org's flows can email with the "Send email notification" step: team members (userId, opt-out state) and outside addresses (id, status pending/verified/unsubscribed). In that step's `recipients`, use refs: "role:all", "role:admins", "member:<userId>", or "ext:<id>" (verified only). Free-text addresses are not allowed.

無需輸入參數。

Add an email address outside the team that flows may notify. Neuron emails it a confirmation link; flows can only email it after the person confirms. Owners and admins only.

Remove an outside address so flows can no longer email it. Owners and admins only.

Retrieve audit logs for the organization, showing a chronological record of actions performed by members. Supports filtering by action type and resource.

Retrieve all available built-in tools with their enabled/disabled status for a specific bot. Built-in tools include WhatsApp actions (send messages, delete messages, post status), utility functions (web search, QR codes, weather), scheduling, knowledge base search, and more.

Toggle a built-in tool on or off for a specific bot. Enabled tools become available in the bot's conversations. Example tool IDs: delete_message, post_to_channel, post_status, web_search, send_direct_message, react_to_message, set_reminder, create_poll.

Enable or disable multiple built-in tools at once for a bot. More efficient than toggling tools individually.

Register a new outbound webhook that sends HTTP POST requests to an external URL when specified bot events occur. Supported events: message.created, message.assistant, conversation.created, conversation.escalated, conversation.released, conversation.closed, bot.paused, bot.resumed.

Retrieve all outbound webhooks configured for a specific bot, including their target URLs and subscribed event types.

Modify an existing outbound webhook's configuration, including its destination URL, subscribed event types, or filter prompt.

Permanently remove an outbound webhook. The external endpoint will no longer receive event notifications from this bot.

Retrieve delivery logs for an outbound webhook to monitor event dispatch history and debug delivery failures.

Retrieve all contacts for the current organization with optional filtering by search term, tag, and pagination.

Search contacts by a query string across name, phone number, and email fields. Returns matching contacts ranked by relevance.

Retrieve detailed information about a specific contact including their tags, notes, and associated lists.

Create a new contact in the organization's address book. If notes are provided, they are saved as a structured note entry with source tracking.

Update an existing contact's details. If notes are provided, they are appended as a new structured note entry without overwriting existing notes.

Permanently delete a contact and remove them from all contact lists. This action cannot be undone.

Export all contacts as a downloadable dataset for the current organization.

無需輸入參數。

Bulk import multiple contacts into the organization's address book. Accepts an array of contact objects with name, phone, and optional fields.

Enrich existing contacts with additional data from connected messaging channels. Syncs profile information from linked platforms.

無需輸入參數。

Synchronize contacts from all connected WhatsApp channels into the organization's contact database. Creates new contacts for unseen numbers.

無需輸入參數。

Search contacts using natural language AI-powered semantic search. Finds contacts based on the meaning of their notes — skills, services, schedules, preferences, etc. Returns ranked results with relevance scores and AI-generated match reasons.

Transcribe an audio recording and extract contact information (name, phone, email, notes, tags). Automatically saves the extracted contact to the organization's address book.

Retrieve all contact lists for the current organization with optional filtering by search term, type, and pagination.

Retrieve detailed information about a specific contact list, including member count and configuration.

Create a new contact list. Slug is auto-generated from name if not provided. For dynamic lists, provide criteria with rules and/or an AI prompt.

Update an existing contact list's name, slug, description, criteria, or refresh schedule.

Permanently delete a contact list. System-protected lists (e.g., 'Do Not Contact') cannot be deleted.

Retrieve the members of a specific contact list with optional search filtering and pagination.

Add one or more contacts to a list by contact ID or phone number. Phone numbers without existing contacts are auto-created as minimal contact records.

Remove one or more contacts from a list by their contact IDs. Does not delete the contacts themselves.

Merge two or more contact lists into a single unified list, deduplicating entries. Window merge creates a virtual union; materialized merge creates a static copy.

Retrieve all contact lists that a specific contact belongs to.

Trigger a refresh of a dynamic contact list. Re-evaluates criteria rules and/or AI prompt and materializes updated members.

Create a paced campaign that messages the next N un-reached members of a contact list on a schedule. The cursor follows the LIVE list — as members are added or removed, only current members get reached, and nobody is messaged twice per cycle. Multiple campaigns can run on the same or different lists concurrently. On exhaust, either stop or loop (start over after a cooldown).

List all paced list campaigns for the organization, optionally filtered to a single contact list.

Get a paced list campaign with live progress: how many members have been reached this cycle, the current list size, and how many remain.

Update a paced list campaign's name, message source, batch size, schedule, exhaust behavior, or send settings. Changing the schedule reschedules the next run.

Pause a paced list campaign. No further batches run until resumed. The cursor is preserved.

Resume a paused paced list campaign. It picks up from where the cursor left off.

Fire the next batch of a paced list campaign immediately (on the next worker tick, ~30s), regardless of its schedule. The schedule continues normally afterward.

Permanently delete a paced list campaign and its reached-set. Does not delete the contacts or the list.

Retrieve a paginated list of all broadcasts with optional filtering by status such as draft, sent, or scheduled.

Create a new broadcast message in draft status. Provide recipients directly or use recipientSources to resolve from contact lists. The WhatsApp channel is auto-resolved if not specified.

Retrieve detailed information about a specific broadcast, including its status, message content, and recipient summary.

Retrieve the paginated list of recipients for a specific broadcast with their individual delivery status.

Update an existing broadcast's name, message content, or media before sending. The broadcast must still be in draft status.

Permanently delete a broadcast and its recipient data. This action cannot be undone.

Send a broadcast message to all its recipients. The broadcast must be in draft status. This triggers message delivery and cannot be undone.

Retrieve the current billing information, subscription plan, and usage details for the organization.

無需輸入參數。

Initiate a checkout session for a subscription plan upgrade. Returns a checkout URL or confirmation to complete the purchase.

Cancel the current active subscription. Access continues until the end of the current billing period.

無需輸入參數。

Upload a media file (image, video, audio, or document) by providing its base64-encoded content. Returns a URL for use in messages and broadcasts.

Rewrite or rephrase text using AI with specified tone, style, or instructions (e.g., make it more formal, translate, summarize).

Retrieve all campaigns for the current organization with optional status filtering and pagination.

Retrieve detailed information about a specific campaign including its status, budget, participants, and delivery metrics.

Browse available campaigns in the marketplace that your organization can join to earn rewards by sending messages.

Create a new outreach campaign with target audience, messaging template, and schedule configuration. Requires a Pro or Business plan.

Update a campaign that is in 'draft' or 'rejected' status. Active or completed campaigns cannot be modified.

Permanently delete a campaign that is in 'draft' status. Active or funded campaigns cannot be deleted.

Submit a draft campaign for admin review and approval. The campaign must be in 'draft' status.

Fund an approved campaign by deducting the total budget from the organization's wallet balance. Requires sufficient wallet funds.

Join a marketplace campaign as a participant to earn rewards by sending messages through your WhatsApp channel.