Neuron

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.

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

Retrieve message history for a specific conversation with cursor-based pagination. 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.

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

Browse verified contact lists available in the shared marketplace pool. Filter by category, region, or search term.

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

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 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.

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).

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

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

Retrieve all participants who have joined a campaign you own, including their delivery counts and earned rewards.

Cancel a still-pending approval (e.g. the upstream action was aborted). Fires the approval.cancelled callback. Requires a bot API key.

Cancel a confirmed or pending booking. Sends cancellation notifications to the invitee.

Cancel a running or waiting flow execution. Steps already completed are not rolled back.

Cancel a scheduled message to prevent it from being sent. Only messages with status 'scheduled' can be cancelled. This action cannot be undone.

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

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

Delete messages (and their media) from chats; the conversations stay, empty. Chats a human is currently handling, or that a flow is waiting on, are skipped. Only Neuron's copy — nothing is deleted from WhatsApp. DRY RUN by default. To clear without picking conversations, pass execute: true AND confirmChats equal to the number of chats from the preview. Irreversible.

Remove media files (photos, videos, voice notes, documents) from chats while keeping the messages and captions; chats show 'Media removed'. Only Neuron's copy — nothing is deleted from WhatsApp. DRY RUN by default: returns how many messages/files/bytes would go. Pass execute: true to run it (irreversible).

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

Mark a confirmed booking as completed (e.g. after the meeting has happened).

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

Confirm a pending booking. Only works on bookings with status 'pending'.

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

Create an ad distribution request to send a message to contacts in pool lists matching target demographics. Deducts from wallet upon approval.

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

Create a new blog post. Body can be authored two ways: (1) `content` as markdown (GFM) + inline raw HTML, or (2) `blocks` — a structured array of typed layout blocks rendered as styled components (heroes, columns, callouts, code cards, embeds, CTAs, sanitized custom HTML). Prefer `blocks` for rich, magazine-style layouts; use `content` for simple prose. If both are given, `blocks` renders and `content` is kept as a fallback.

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

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.

Create a new booking calendar with a name, timezone, and visibility setting.

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

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

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.

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.

Create a host-initiated event on a calendar. Supports attendees (with WhatsApp/email invitations), location, and daily/weekly/monthly recurrence.

Create a bookable event type on a calendar (e.g. '30-min consultation').

Create a new automation flow. A flow is a directed graph of nodes connected by edges. The graph MUST start with at least one trigger node (entry point). Edges connect nodes via output handles. BEFORE BUILDING: call neuron_get_flow_catalog and read its `reference` — it carries the JSON shapes you cannot guess: the ConditionGroup + operator list for branch/filter/switch conditions, the `cases`/`assignments`/`weekdays` composite shapes, the handle wiring map, and copy-ready `examples`. Condition `field` on a logic node must be a {{template}} (e.g. '{{trigger.text}}'); on a trigger's config.condi…

Create a new WhatsApp group and seed its members from any combination of sources: other groups (combine/copy), contact lists, individual contacts, pasted phone numbers, or the whole address book. Optionally pass a unique `slug` to address the group later without its JID. Members blocked by privacy come back in the failed list. Uses the org's default connected session unless `channelId` is given.

Create an Instagram list. Names are unique per organization (case-insensitive).

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

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

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}).

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).

Create a new WhatsApp Channel newsletter for one-way broadcast updates. Requires a connected Baileys session on the specified channel.

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.

Create a digital product/service with a public checkout link. Amount in kobo (minor units): ₦1 = 100. Minimum ₦500 = 50000. For 'file' delivery, upload the file first (neuron_upload_media) and pass its URL as deliveryFileUrl. On payment, Neuron confirms it and delivers the product to the buyer's WhatsApp automatically.

Create a draft SMS campaign. Choose the audience via sourceType: 'all_contacts' or 'contact_list' (your own contacts), 'phones' (bring your own list — raw numbers you pass in), 'platform' (the wider Neuron audience — budget required, sent over the bulk campaign route), or 'curated' (SMS-opted-in marketplace lists via poolEntryIds; the list owner earns ₦2/contact). After creating, call neuron_estimate_sms_campaign to price it, then neuron_send_sms_campaign. Requires SMS to be enabled by an admin and a configured provider.

Create a new social media channel with platform credentials. Supports Instagram and Twitter/X. Credentials should be the full session JSON including account, cookies, headers, and platform-specific tokens.

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.

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

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

Permanently delete a draft ad request. Only ad requests in draft status can be deleted.

Permanently delete a blog post by its ID. This action cannot be undone.

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

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

Permanently delete a calendar and all its event types, bookings, and availability data.

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

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

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

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

Delete a host-created event. For recurring events, use scope to control what gets deleted: 'single' (just this one), 'future' (this and all future), or 'all' (entire series).

Permanently delete an event type and all its bookings.

Soft-delete a flow. It stops running but can be restored for 30 days with neuron_restore_deleted_flow. Running executions are not cancelled.

Permanently delete a completed, failed, or cancelled flow run and all its step data.

Delete an Instagram list and its members. Flows filtering on it stop matching anyone.

Permanently delete a specific entry from a knowledge base.

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

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

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

Permanently delete a WhatsApp Channel newsletter and remove it from WhatsApp. This action cannot be undone.

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

Remove a date-specific availability override, reverting to the default weekly hours.

Delete a voice persona.

Permanently delete a product. Existing orders are retained.

Delete a draft SMS campaign. Only draft campaigns can be deleted.

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

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

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

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

Re-send a paid-but-undelivered order to the buyer over WhatsApp/email. Use when a sale settled while no WhatsApp session was connected; connect one first, then deliver.

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

Prepare a zip of the workspace's chat media (one folder per chat), or get the download link of a finished one. Call without exportId to start an export; call with exportId to get a 10-minute download link once it's ready. Zips are kept for 72 hours.

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.

Clone an existing product into a hidden draft copy (new checkout link, '(copy)' title, reset counters). A 'pool' code product is cloned with an empty pool — restock codes before enabling. Edit the copy with neuron_update_product, then set enabled: true to publish.

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

Manually enroll existing / off-platform people into a membership product WITHOUT a payment. Use this to backfill members who were already in the WhatsApp group before you switched membership on, so the renewal + eviction cycle applies to them too. No order or revenue is booked. Each enrolled member gets a free first period (firstPeriodDays, or one normal interval by default), then renews like everyone else — reminder-only until they connect a Neuron account (no auto-charge). Existing members are left untouched (counted as skipped). Returns { enrolled, skipped, total }.

Price a draft SMS campaign before sending: returns recipient count, SMS provider cost, curated owner payout (₦2/contact), and the total in kobo. Call this before neuron_send_sms_campaign.

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

Export a flow as a portable file (JSON with format "neuron.flow"). Credentials (auth headers, tokens, secret variable values) are blanked and listed in `redacted`. Pass the returned object to neuron_import_flow to copy the flow into this or another account.

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}).

Retrieve all contact lists that a specific contact belongs to.

Forward a WhatsApp message from one chat to another. Uses copy-send approach — the message content is re-sent to the destination.

Fund an approved ad request from the organization wallet. This debits the budget amount and activates the campaign for distribution. If wallet balance is insufficient, returns shortfall information instead of an error.

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

Initialize a wallet funding transaction via Paystack. Returns a checkout URL to complete the payment in a browser.

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

Get detailed information about a specific ad request, including pool selections if targeting mode is manual.

Retrieve delivery analytics and performance breakdown for a specific ad request, including delivery rates and cost metrics.

Fetch a single approval request by id, including its decision once resolved. Set waitSeconds (1–60) to long-poll until it resolves. Requires a bot API key.

Retrieve the default availability schedule (weekly hours + timezone) for a calendar.

Compute available time slots for an event type over a date range, accounting for availability, existing bookings, buffers, and Google Calendar busy times.

Retrieve the saved bank account details currently configured as the organization's payout destination.

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

Fetch the list of all blocked WhatsApp contacts for the bot on the given channel.

Retrieve a single blog post by its URL-friendly slug, including full content and metadata.

Retrieve details of a specific booking.

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

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

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.

Fetch the WhatsApp Business profile of an external contact, including description, website, category, and business hours.

Retrieve details of a specific calendar by its ID.

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

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

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 the current connection status and session details for a specific channel (e.g., connected, disconnected, qr_pending).

Fetch a collection's metadata by id.

Browse the mined content in a collection — posts/comments/profiles with author, content, engagement and engagementScore. sort 'top' ranks by engagement (great for picking the best clips/posts to reuse or distill into a persona).

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

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

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

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

Retrieve contacts eligible to receive a campaign message. Respects deduplication rules and mutual contact requirements.

Retrieve details of a specific event type.

Retrieve a single flow by id, including its full graph (nodes and edges), enabled status, and run stats.

Retrieve the COMPLETE catalog for authoring flows. ALWAYS call this first when building or editing a flow — do not rely on memory, the full node set changes. The response has two parts: • `data`: every node type (all triggers, logic, and actions) with its config `fields` (including `options` enums and `required`), output `handles`, and `dynamicHandles`. • `reference`: the authoring guide you need for anything non-trivial — - `conditions`: the ConditionGroup JSON shape + the full operator vocabulary (used by branch/filter/switch/loop and trigger filters). Note: on LOGIC nodes a rule's…

Get one saved version of a flow with its full graph, to compare with the current flow before restoring.

Get a single flow run with its full step-by-step execution trace. Each step shows the node type, input/output, status (ok/error/skipped/wait), duration, and which handle fired. Use this to debug flows — see exactly what happened at each step.

Get the invite link for a WhatsApp group. Only supported on Baileys channels where the bot is a group admin.

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

Read an Instagram channel's greeting prompts (ice breakers: up to 4 questions shown when someone opens an empty chat) and its persistent chat menu. Only for accounts connected with Instagram login (authMethod official).

Page through an Instagram list's members (username, Instagram id once known, how they were added).

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

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

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

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

Retrieve detailed information about a specific WhatsApp Channel newsletter, including subscriber count and metadata.

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

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

Get one voice persona (full voiceProfile + exemplars).

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

Fetch the bot's current WhatsApp privacy settings (last seen, online, profile picture, status, read receipts, groups add).

Get a single product by id, with its public URL and fee breakdown.

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

Retrieve detailed information about a specific scheduled message, including its status, send time, and message content.

Retrieve a single SMS campaign with its status and delivery counters.

Retrieve detailed information about a specific social media channel, including its platform, credentials status, and connection state.

Retrieve the current session status for a social media channel (e.g., connected, disconnected, error).

Get this seller's storefront profile (handle, display name, bio, branding) and its public URL.

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

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

Disconnect a calendar from Google Calendar sync.

Check whether a calendar is connected to Google Calendar and when it last synced.

Approve or reject pending join requests for a WhatsApp group. Requires admin privileges.

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

Create a new flow from an exported flow file (the object neuron_export_flow returns). It is always created switched OFF and never overwrites an existing flow. Inbound webhook URLs get new slugs. The response lists `missing` (steps pointing at a bot, list, session or knowledge base this account doesn't have, which need picking before switching on) and `redacted` (credentials blanked on export that need refilling).

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.

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

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.

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

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

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.

Counts of leads by status.

Make the bot leave a WhatsApp group. This action is irreversible — the bot will need to be re-added by an admin.

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

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

List approval requests for the organization, newest first. Filter by status (pending/approved/rejected/expired/cancelled). Requires a bot API key.

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

Retrieve a paginated list of blog posts with optional filtering by status, author type, author ID, or tag.

List bookings (inbound and host-created) with optional filters for calendar, status, date range, and source.

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

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

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

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

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.

Retrieve all booking calendars for the current organization.

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

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

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

List content collections (where web-agent missions and captures land). Returns each collection's item count, kind and source.

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

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

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

List flows deleted in the last 30 days, which can still be restored with neuron_restore_deleted_flow.

Retrieve all event types, optionally filtered by calendar.

List host-created events, optionally filtered by calendar and date range.

List the last saved versions of a flow (newest first, up to 3). Each is the flow as it was before a change replaced it, with who saved it, when, and where from (editor, mcp, restore). Back up before risky edits by checking this, and roll back with neuron_restore_flow_revision.

List execution runs for a flow, newest first. Each run shows status (running/waiting/completed/failed/cancelled), trigger type, step count, and timing.

List all automation flows in the organization. Returns each flow's id, name, description, enabled status, trigger events, run count, and last run time.

List the organization's Instagram lists (any name the user chose, e.g. VIPs, giveaway entrants, blocked) with member counts. Use a list's id as `inList` / `notInList` on Instagram flow triggers, or `listId` on the add/remove list flow steps.

List an Instagram channel's recent posts (newest first) with id, caption, type, thumbnail, permalink, date and comment count. Use the ids in a comment trigger's mediaId (a list) to limit a flow to specific posts. Only for accounts connected with Instagram login (authMethod official).

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

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

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

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

Retrieve all knowledge bases accessible to the current user.

List configured lead sources for the org.

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

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

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

Retrieve a paginated list of all WhatsApp Channel newsletters for the organization, with optional filtering by WhatsApp session channel.

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.

List recent product orders (sales) for this seller, with buyer, amount, fee breakdown, and status.

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

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

List date-specific availability overrides for a calendar (e.g. holidays, special hours).

Retrieve the payout history for the organization, including amounts, statuses, and timestamps.

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

List all products for this seller, each with its public checkout URL and price breakdown.

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

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

List verified-purchase reviews across this seller's products (rating, text, buyer, status).

Retrieve a paginated list of scheduled messages for the current organization, with optional filtering by status (scheduled, sent, failed, cancelled).

List the organization's SMS campaigns, optionally filtered by status or type.

Retrieve all social media channels (Instagram, Twitter/X) configured in the current organization.

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').

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

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

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

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').

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)

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

Mark a WhatsApp message as read, sending read receipts to the sender.

Mark a booking as no-show when the invitee did not attend.

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 campaigns the current organization has joined as a participant, including earnings and delivery stats.

Pause an active ad request campaign. Distribution stops until resumed. Only active ad requests can be paused.

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

Pause an active campaign to temporarily stop message delivery. Can be resumed later with the resume action.

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

Pause a sending drip SMS campaign. Only drip campaigns in the 'sending' state can be paused.

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

Post a message to a WhatsApp Channel newsletter. All subscribers receive the message. Provide at least one of text or mediaUrl. This triggers delivery and cannot be undone.

Publish to one of the organization's connected social accounts (by channel id from neuron_list_social_channels). Text and/or up to 10 media items (several items make an Instagram carousel). Set as='story' to publish one image or video as an Instagram story (Instagram accounts connected with Instagram login; stories don't show a caption). Media URLs must be publicly reachable; Instagram images must be JPEG.

Post a WhatsApp Status / Story from a connected direct (Baileys) WhatsApp number. Visible to the account's synced contacts for 24 hours — you do NOT specify recipients (the contact list is built automatically; pass statusJidList only to target a subset). Provide at least one of text or mediaUrl. channelId is optional and auto-resolves to the default connected number. This triggers delivery and cannot be undone.

List the members of a membership product: current (paid-up) or all. Returns each buyer's status (active / lapsed / cancelled), when their period renews, whether they're in the attached WhatsApp group (if one is attached), plus totals.

Publish a blog post, making it publicly visible. The post must be in 'draft' status.

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

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

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

Re-fetch metadata (name, description, subscriber count) for a WhatsApp Channel newsletter from WhatsApp to synchronize local data.

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

Refund a paid order via Paystack. The buyer is refunded and the sale amount is reversed from your wallet.

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

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

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

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

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

Remove one member (by member id from neuron_get_instagram_list_members) from an Instagram list.

Remove members from a group, resolved from any combination of sources — e.g. remove everyone on a contact list. Address the group by its id, slug, or JID.

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

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

Remove the bot's WhatsApp profile picture, reverting to the default.

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

Ask a human to approve or reject an action over WhatsApp and get the decision back. The recipient replies approve/reject (optionally with a reason) or quotes the message. Use this to gate any action needing human sign-off (refunds, deploys, spend, publishing). Returns an approvalId; poll neuron_get_approval / neuron_list_approvals for the outcome, or supply a webhook in `callback` to be notified. Requires a bot API key ('nrn_' prefix).

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

Request a payout to transfer funds from the organization wallet to the linked bank account. A bank account must be saved first.

Reschedule a booking to a new time. Creates a new booking and marks the old one as rescheduled.

Approve or reject a pending approval programmatically — the decision surface for an authorized operator acting via MCP instead of replying on WhatsApp. Fires the configured callback and posts the outcome to the WhatsApp chat. Exactly-once: the first responder (here or on WhatsApp) wins; later responses return 410. Requires a bot API key.

Bring back a flow deleted in the last 30 days. It comes back switched off; switch it on with neuron_toggle_flow.

Put a saved version of a flow back. The current graph is saved as a revision first, so the restore can itself be undone. The flow keeps its name and on/off state.

Resume a paused ad request campaign. Distribution resumes from where it left off. Only paused ad requests can be resumed.

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

Resume a previously paused campaign to restart message delivery.

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

Resume a paused drip SMS campaign.

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

Revoke the current group invite link and generate a new one. The old link will stop working. Requires admin.

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

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

Manually trigger a flow run for testing. Starts at the 'trigger.manual' node if present, otherwise the first trigger node. Optionally provide a payload object that becomes {{trigger.*}} in the flow.

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

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.

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

Total paid sales count and net revenue (kobo) for this seller.

Save a verified bank account as the organization's payout destination. Verify the account first using neuron_verify_bank_account.

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

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

Check whether this account can sell (Pro plan + admin-granted access) and any pending application.

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.

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

Send a campaign message to selected eligible contacts via WhatsApp. Requires the campaign to be in 'active' status and contacts to be eligible.

Send a vCard contact card via WhatsApp with name, phone, and optional organization.

Send a location pin via WhatsApp with coordinates and optional name/address.

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

Send a poll message via WhatsApp. Polls support 2-12 options and optional multi-select. Only supported on Baileys channels.

Send or remove an emoji reaction on a WhatsApp message. Pass an empty emoji string to remove a reaction.

Send a draft SMS campaign. Debits the wallet for the SMS cost plus any curated owner payout, then queues delivery. Returns a 402 with shortfall details if the wallet balance is insufficient (fund the wallet with neuron_fund_wallet and retry).

Send a sticker via WhatsApp. The easy way: pass `sticker` as a mood or label (e.g. 'laughing', 'thumbs up', 'fire', 'celebrate') and a matching sticker is found automatically from the platform-wide community sticker library (falling back to this org's own stickers). Advanced: pass `stickerUrl` with a direct public WebP image URL instead. Provide one of the two. Only supported on Baileys channels.

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.

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.

Enable or disable join approval mode for a WhatsApp group. When enabled, join requests must be manually approved by admins. Requires admin.

Replace an Instagram channel's greeting prompts (max 4) and persistent chat menu (max 20 items). Pass the full lists; an empty list removes that part. A tap sends a postback with the item's payload: it fires flows with the "Instagram button tapped" trigger, and the channel's bot answers taps no flow handles (as if the person typed the title). Menu items are either a postback (payload) or a link (url).

Set a date-specific availability override — mark a day as unavailable, or set custom hours for that date.

Set typing indicator or online/offline presence on a WhatsApp chat. Only supported on Baileys channels.

Business plans: is this address free for a new site? Returns { available, code, message }. The create call re-checks.

Permanently wipe a site: every version, its files in storage, people, access requests and view history. The address stops working. Cannot be undone or recovered. Use neuron_sites_set_access {paused:true} to take it down temporarily instead.

Permanently delete an old (non-live) version of a site, e.g. a wrong upload. Its files are removed from storage right away, except files other versions still use. The live version can't be deleted (roll back first). Cannot be undone.

Copy a site's live files into a new site with a new address (addresses never change, so this is how to get a different one). No re-upload. The copy starts Restricted with nobody added and goes through review like any new site.

One site's details: URL, share link, access settings, versions (for rollback) and the people who have access.

List access requests for a site (pending, approved, denied, expired). `repeat: true` marks people who asked before.

List the org's Neuron Sites (static sites with Docs-style sharing) with URL, access mode, size and pending access requests, plus plan limits.

Publish a static site (HTML/CSS/JS/images/fonts/PDF/video) and get its link. Creates a new site when siteId is omitted, otherwise redeploys to the same URL — the link and access settings survive and the previous version stays available for rollback. Pass exactly one source: `dir` (local folder, e.g. the output of a build), `zipPath` (local .zip), `html` (a single page), or `files` ([{path, base64}]). New sites start Restricted (only you). Use neuron_sites_set_access to share. Only changed files are uploaded on redeploy. A new site is reviewed by Neuron once; until approved (`reviewStatus`), vi…

Approve or deny an access request. Approved people become named viewers (optionally until expiresAt) and get in on their next visit — no new link needed. They're notified either way.

Make an earlier version live again at the same URL. Omit versionId to go back one version.

Control who can open a site, Google Docs style. generalAccess: 'restricted' (only named people), 'link' (anyone with the unguessable link), 'request' (anyone can ask; you approve), 'org' (members of your Neuron org), 'domain' (verified emails on allowedDomains), 'public' (anyone — requires confirmPublic). Optionally add a password (applies to everyone but owners), add/remove named people (email / WhatsApp number / Neuron user id, with optional expiry), rotate the link (old link dies instantly), set a link expiry, or pause the site. Every change logs current viewers out within ~15 seconds.

Rename a site, change its entry page, toggle owner email alerts, allow external resources (CDN scripts/styles/images over https), or choose what link previews show. Content changes go through neuron_sites_publish.

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

Start or reconnect a social media session for the channel. Initializes the platform client with stored credentials.

Stop an active or paused ad request campaign permanently. Any remaining unspent budget is refunded to the organization wallet. This cannot be undone.

Permanently stop an active campaign and refund the remaining unspent budget to the organization's wallet. This action cannot be undone.

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

Stop the active session for a social media channel. The channel can be restarted later.

Status and result of a clear-media / clear-chat job started by neuron_clear_media or neuron_clear_chat.

How much chat media the workspace stores (by type), its media retention window, and recent media downloads.

Build a new video or edit an existing one from a natural-language instruction. Returns the updated ProjectDoc plus the list of edits made. Pass the returned `doc` back in to keep iterating, or to neuron_studio_render to produce an MP4. Does NOT render.

Apply a batch of Studio tool calls to a video doc and get back the updated doc plus a fresh scene description — YOU (this agent) are the brain, so this needs NO OpenRouter/AI key. Loop: call neuron_studio_catalog once, then neuron_studio_apply with { doc, calls:[{tool,args}] }, read the returned `scene`, apply more, and finally neuron_studio_render. Omit `doc` (with an optional `platform`) to start a fresh video.

Get the Studio's editing vocabulary — every tool (add_text, add_shape, animate_layer, set_visibility_window, group, trim_clip, add_overlay, add_scene, set_transition, …) with its JSON-schema arguments. Read this first when driving the Studio yourself with neuron_studio_apply.

Text → image (AI b-roll) via the org's Replicate key. Returns { url } (an external URL). Re-host it (neuron_studio_rehost_media) so it persists, then place it with neuron_studio_apply add_image. Business plan + an image-model version configured in Studio settings.

Text → video via Replicate (async). Returns { id, status } — poll neuron_studio_generate_video_status until 'succeeded' to get videoUrl, then re-host + add_video. Needs a genvideo model version configured.

Poll an AI video job. When status is 'succeeded', videoUrl is the result (external — re-host it before use).

Fetch a video from a direct link or a platform page (YouTube / Instagram / TikTok / X / LinkedIn) and re-host it so the Studio + renderer can use it. Returns { url, filename, kind, w, h, durationMs }. Put the returned url on a video layer in the ProjectDoc.

One-shot: build/edit a video from a prompt AND start the MP4 render. Returns the ProjectDoc, the edits, and a render `job` — poll it with neuron_studio_render_status until status is 'completed' to get the outputUrl. Great for 'make me a 20s TikTok reel about X'. Requires a Pro+ plan.

Fetch any image/video/audio URL and re-host it on Neuron so it's stable and server-reachable — use this on external/temporary URLs (AI-generated b-roll, etc.) before placing them with add_image/add_video/add_audio. Returns { url, filename }.

Submit a Studio ProjectDoc for a headless MP4 render. Returns a job id — poll neuron_studio_render_status until 'completed'. Any media (video/image) in the doc must be a server-reachable URL (use neuron_studio_import_media_url / neuron_studio_upload_media first). Requires a Pro+ plan.

Poll a render job by id. When status is 'completed', outputUrl is the finished MP4. status is queued | rendering | completed | failed.

Persist a ProjectDoc and get back an `openUrl`. Opening it drops the video into the Studio in the user's browser, where 'Export MP4' renders CLIENT-SIDE (on their machine, no server render cost). Use this for the hybrid flow: build with neuron_studio_apply/agent, then save and hand the user the link. Use neuron_studio_render instead only for headless/unattended server renders.

Transcribe a hosted media/audio URL into time-coded caption cues { cues:[{startSeconds,endSeconds,text}] }. Feed them to neuron_studio_apply add_captions to subtitle existing footage. Needs a transcription key on the org.

Run an AI transform on a hosted video via Replicate (async): op 'bg-remove' or 'face-swap' (face-swap needs imageUrl). Returns { id, status } — poll neuron_studio_transform_video_status for videoUrl. Needs the matching model version configured.

Poll a video-transform job. When status is 'succeeded', videoUrl is the result (external — re-host before use).

Upload a local image/video (base64) to the Studio media store (uncapped) so the renderer can fetch it. Returns { url, filename }. Put the url on an image/video layer.

Turn a script into a hosted voiceover audio URL, optionally with caption cues synced to the speech. Returns { url, durationSeconds, cues? }. Then place it with neuron_studio_apply: add_audio({url, label:'Voiceover', durationSeconds}) and add_captions({cues}). This makes fully-voiced reels possible from a prompt. Needs a TTS key on the org (captions also need a transcription key).

Submit a draft ad request for admin review. The request must be in draft status. After submission, an admin must approve it before it can be funded.

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

Submit a contact list to the shared pool marketplace for other organizations to discover and use for ad distribution.

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.

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

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

Synchronize and import WhatsApp Channels from a connected WhatsApp session into Neuron. Discovers channels created outside Neuron.

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

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

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

Find available slots across all team calendars. Mode 'any' returns slots where at least one member is free (round-robin), 'all' requires everyone to be free (collective).

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

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.

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

Enable or disable a flow. Disabled flows stop receiving events but retain their graph.

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

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

Remove the bot assignment from a social media channel. The bot will lose access to the channel's social media credentials.

Unblock a previously blocked WhatsApp contact.

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

Update a draft or rejected ad request. Only draft and rejected ad requests can be edited. Rejected requests revert to draft on update.

Set the weekly availability hours for a calendar. Each day maps to an array of { start, end } time windows in HH:mm format.

Update an existing blog post's content, metadata, status, or SEO fields. Only provided fields are changed.

Add or update host notes on a booking.

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

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

Update a calendar's settings. Only provided fields are modified.

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

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

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

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

Update a host-created event. Use scope='future' to update all future instances of a recurring series.

Update an event type's settings. Only provided fields are modified.

Update a flow's name, description, graph, or enabled state. Only provided fields are changed. When updating the graph, provide the COMPLETE graph (all nodes and edges) — it replaces the existing graph entirely. The previous graph is kept as a revision (see neuron_list_flow_revisions), so a bad edit can be rolled back with neuron_restore_flow_revision. When a graph is supplied the response includes a non-blocking `warnings` array (same checks as create_flow) — check it and fix any flagged issues.

Update the description of a WhatsApp group. Requires the bot to be a group admin.

Add, remove, promote, or demote members in a WhatsApp group. Provide phone numbers or JIDs. Requires admin privileges.

Change WhatsApp group settings: 'announcement' (only admins send), 'not_announcement' (everyone sends), 'locked' (only admins edit info), 'unlocked' (everyone edits info). Requires admin.

Update the name/subject of a WhatsApp group. Requires the bot to be a group admin.

Rename an Instagram list or change its description.

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

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

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

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

Update the name or description of an existing WhatsApp Channel newsletter. Only provided fields are changed.

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

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

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

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.

Update a specific WhatsApp privacy setting. Settings: lastSeen (all/contacts/contact_blacklist/none), online (all/match_last_seen), profilePicture (all/contacts/contact_blacklist/none), status (all/contacts/contact_blacklist/none), readReceipts (all/none), groupsAdd (all/contacts/contact_blacklist).

Update any field of a product (price, delivery, cover, enabled, fee payer, …).

Update the bot's WhatsApp display name on the given channel.

Update the bot's WhatsApp profile picture from an image URL.

Update the bot's WhatsApp status/bio text.

Update the message content, media, or send time of a scheduled message. Only messages with status 'scheduled' can be updated.

Update an existing social media channel. Can update label, username, or refresh credentials.

Create or update the seller storefront (nestuge-style page). Handle is auto-generated from the display name if omitted.

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

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

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

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

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

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

Test whether the stored credentials for a social channel are still valid by making a test API call to the platform.

Verify a Nigerian bank account number via Paystack to confirm the account holder name before saving.

Verify a wallet funding transaction using the Paystack payment reference to confirm the payment was successful.

Retrieve the current wallet balance for the organization, including available and pending amounts.

Retrieve the wallet transaction history for the organization, with optional filtering by transaction type.

See the launch/stop/open commands queued for the extension and their outcomes (pending|claimed|done|failed, plus the runId a launch created).

Fetch one run's status, config snapshot and latest live stats (captured/flushed/leads/reels/hops/scrolls). status is running|stopped|completed|killed|stale.

The kill switch — flags a run to stop. It's cooperative: the browser extension stops on its next heartbeat (usually within ~12s) and finalizes the run.

List browser-mission runs (live + recent). Stale runs (no heartbeat >2min) show as 'stale'. Note the result nests as data.data[].

Ask the extension to open its Web Agent panel so the user can review/adjust a mission before it runs. Delivered on the extension's next poll.

Queue a browser mission for the user's Neuron extension to run — mine content into a Collection or prospects into the lead pool. Returns a command id; the extension picks it up on its next poll (so the browser must be open, signed in, and remote-control enabled in the extension). Watch it with neuron_webagent_list_runs / neuron_webagent_get_run and stop it with neuron_webagent_kill.

Queue a graceful stop for the current mission (the extension finalizes it). For an immediate hard stop of a specific run, use neuron_webagent_kill.

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