accueil / serveurs / Communication / io.github.conquext/neuron
io.github.conquext/neuron
serveur MCP (Model Context Protocol) · neuron-mcp-server 1.1.2
Référencé dans l'annuaire. Seul le pentest comportemental fait foi, et il n'a pas encore été exécuté sur ce serveur.
Est-ce que io.github.conquext/neuron est sûr ?
Au dernier audit MCP Hub, le serveur MCP « io.github.conquext/neuron » est classé « Non encore testé ». Référencé dans l'annuaire. Seul le pentest comportemental fait foi, et il n'a pas encore été exécuté sur ce serveur. Le verdict est réévalué en continu ; consultez la fiche pour l'état à jour.
Méthode : MCP Hub analyse la description de chaque outil (couche 1) et, pour le verdict fort, exécute le serveur dans une micro-VM isolée avec leurres et réseau bloqué (couche 2). On publie des noms et des compteurs, jamais le contenu brut renvoyé par un outil.
Les 425 outils
- neuron_add_bot_channel≈ 170 tokens
Connect an additional WhatsApp channel to a bot as a secondary number. The bot will respond to messages on this channel.
Paramètres, retour & exemple (2)
ParamètresbotId· string · requis
Unique identifier (UUID) of the botchannelId· string · requis
Unique identifier (UUID) of the WhatsApp channel to connect
Exemple d'appel{"name": "neuron_add_bot_channel", "arguments": {"botId": "texte", "channelId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_add_group_members≈ 362 tokens
Add members to an existing group, resolved from any combination of sources (other groups, contact lists, contacts, pasted phones, all contacts). Address the group by its id, slug, or JID.
Paramètres, retour & exemple (8)
Paramètrestags· array · optionnel
Keep only contacts carrying one of these tagsgroup· string · requis
Group id, slug, or JID (ending in @g.us)phones· array · optionnel
Raw phone numbers, e.g. pasted from a CSVlistIds· array · optionnel
Contact list ids or slugs — pulls every membercontactIds· array · optionnel
Existing contact idsallContacts· boolean · optionnel
Union the org's entire address bookfromGroupIds· array · optionnel
Copy/combine members live from these WhatsApp group JIDsexcludeListIds· array · optionnel
Subtract every member of these lists
Exemple d'appel{"name": "neuron_add_group_members", "arguments": {"group": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_add_notify_recipient≈ 185 tokens
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.
Paramètres, retour & exemple (2)
Paramètresemail· string · requis
The address to invitelabel· string · optionnel
A name for it, e.g. 'Accountant'
Exemple d'appel{"name": "neuron_add_notify_recipient", "arguments": {"email": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_add_product_codes≈ 176 tokens
Add more unique codes/keys to a 'pool' code product's stock. Each buyer receives one. Returns the product with the new remaining count.
Paramètres, retour & exemple (2)
Paramètresid· string · requis
Product UUIDcodes· array · requis
Unique codes/keys to append to the pool
Exemple d'appel{"name": "neuron_add_product_codes", "arguments": {"id": "texte", "codes": []}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_add_to_contact_list≈ 272 tokens
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.
Paramètres, retour & exemple (2)
Paramètresentries· array · requis
Array of contacts to add, each identified by contactId or phone numberidOrSlug· string · requis
Unique identifier (UUID) or URL-friendly slug of the target contact list
Exemple d'appel{"name": "neuron_add_to_contact_list", "arguments": {"entries": [], "idOrSlug": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_add_to_instagram_list≈ 179 tokens
Add Instagram usernames to a list (with or without @, up to 1,000). Their Instagram id is filled in the first time they DM or comment, so the list keeps matching after a rename. Returns added / invalid.
Paramètres, retour & exemple (2)
Paramètresid· string · requisusernames· array · requis
Exemple d'appel{"name": "neuron_add_to_instagram_list", "arguments": {"id": "texte", "usernames": []}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_add_tool_secret≈ 199 tokens
Store or update a secret credential (API key, token, etc.) for a custom tool integration. Secrets are encrypted at rest.
Paramètres, retour & exemple (3)
Paramètresid· string · requis
Unique identifier (UUID) of the tool to add the secret tokey· string · requis
Secret key name used in templates (e.g., 'API_KEY', 'AUTH_TOKEN')value· string · requis
Secret value to store securely (will be encrypted)
Exemple d'appel{"name": "neuron_add_tool_secret", "arguments": {"id": "texte", "key": "texte", "value": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_apply_persona_to_bot≈ 180 tokens
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.
Paramètres, retour & exemple (2)
Paramètresid· string · requis
Persona UUIDbotId· string · requis
Bot UUID to apply the voice to.
Exemple d'appel{"name": "neuron_apply_persona_to_bot", "arguments": {"id": "texte", "botId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_apply_to_sell≈ 130 tokens
Apply for seller access (digital products). Requires a Pro plan or higher; a platform admin then grants access.
Paramètres, retour & exemple (1)
Paramètrespitch· string · optionnel
Short note on what you plan to sell
Exemple d'appel{"name": "neuron_apply_to_sell", "arguments": {"pitch": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_approve_reflection≈ 142 tokens
Approve a bot-generated reflection to incorporate the learned insight into the bot's future behavior and responses.
Paramètres, retour & exemple (1)
Paramètresid· string · requis
Unique identifier (UUID) of the reflection to approve
Exemple d'appel{"name": "neuron_approve_reflection", "arguments": {"id": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_assign_bot_to_channel≈ 165 tokens
Assign a bot to handle incoming messages on a specific WhatsApp channel. Replaces any previously assigned bot.
Paramètres, retour & exemple (2)
Paramètresid· string · requis
Unique identifier (UUID) of the channelbotId· string · requis
Unique identifier (UUID) of the bot to assign
Exemple d'appel{"name": "neuron_assign_bot_to_channel", "arguments": {"id": "texte", "botId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_assign_bot_to_social_channel≈ 203 tokens
Set the bot for a social media channel. A channel has one bot: it answers the channel's DMs and can use the channel's credentials for social media actions. Assigning replaces the channel's current bot (the response's replacedBotId says which).
Paramètres, retour & exemple (2)
Paramètresid· string · requis
Unique identifier (UUID) of the social channelbotId· string · requis
Unique identifier (UUID) of the bot to assign
Exemple d'appel{"name": "neuron_assign_bot_to_social_channel", "arguments": {"id": "texte", "botId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_attach_knowledge_base≈ 221 tokens
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.
Paramètres, retour & exemple (3)
Paramètresid· string · requis
Unique identifier (UUID) of the botpriority· number · optionnel
Priority level for knowledge base retrieval (higher values are checked first)knowledgeBaseId· string · requis
Unique identifier (UUID) of the knowledge base to attach
Exemple d'appel{"name": "neuron_attach_knowledge_base", "arguments": {"id": "texte", "knowledgeBaseId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_audio_contact≈ 196 tokens
Transcribe an audio recording and extract contact information (name, phone, email, notes, tags). Automatically saves the extracted contact to the organization's address book.
Paramètres, retour & exemple (2)
ParamètresaudioBase64· string · requis
Base64-encoded audio data containing spoken contact informationaudioFormat· string · optionnel
Audio format hint for decoding (default: 'webm')
Exemple d'appel{"name": "neuron_audio_contact", "arguments": {"audioBase64": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_block_contact≈ 168 tokens
Block a WhatsApp contact. Blocked contacts cannot message the bot or see its profile.
Paramètres, retour & exemple (2)
Paramètresjid· string · requis
Contact JID or phone number to block (e.g. '2348012345678' or '2348012345678@s.whatsapp.net')channelId· string · requis
WhatsApp channel identifier (UUID)
Exemple d'appel{"name": "neuron_block_contact", "arguments": {"jid": "texte", "channelId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_bot_api_chat≈ 236 tokens
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.
Paramètres, retour & exemple (4)
ParamètresapiKey· string · requis
Bot API key with 'nrn_' prefix for authenticationmessage· string · requis
The message text to send to the botcontactName· string · optionnel
Display name of the contact for conversation contextcontactPhone· string · requis
Phone number of the contact sending the message (E.164 format, e.g., '+2348012345678')
Exemple d'appel{"name": "neuron_bot_api_chat", "arguments": {"apiKey": "texte", "message": "texte", "contactPhone": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_bot_api_get_bot≈ 137 tokens
Retrieve configuration and status information about the bot associated with the provided API key.
Paramètres, retour & exemple (1)
ParamètresapiKey· string · requis
Bot API key with 'nrn_' prefix for authentication
Exemple d'appel{"name": "neuron_bot_api_get_bot", "arguments": {"apiKey": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_bot_api_get_messages≈ 245 tokens
Retrieve message history for a specific conversation with cursor-based pagination. Requires a valid API key.
Paramètres, retour & exemple (4)
Paramètreslimit· number · optionnel
Maximum number of messages to return (default: 50)apiKey· string · requis
Bot API key with 'nrn_' prefix for authenticationbefore· string · optionnel
Cursor for pagination — retrieve messages created before this message ID or ISO 8601 timestampconversationId· string · requis
Unique identifier (UUID) of the conversation to retrieve messages from
Exemple d'appel{"name": "neuron_bot_api_get_messages", "arguments": {"apiKey": "texte", "conversationId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_bot_api_list_conversations≈ 236 tokens
Retrieve a paginated list of conversations managed by the bot. Supports filtering by conversation status. Requires a valid API key.
Paramètres, retour & exemple (4)
Paramètrespage· number · optionnel
Page number for pagination (default: 1)limit· number · optionnel
Number of conversations per page (default: 20)apiKey· string · requis
Bot API key with 'nrn_' prefix for authenticationstatus· string · optionnel
Filter by conversation status: 'active', 'closed', or 'pending'
Exemple d'appel{"name": "neuron_bot_api_list_conversations", "arguments": {"apiKey": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_bot_api_send≈ 348 tokens
Send an outbound message through the bot API to a specified phone number. Supports text and media messages. Requires a valid API key.
Paramètres, retour & exemple (7)
Paramètresto· string · requis
Recipient's phone number (E.164 format, e.g., '+2348012345678')apiKey· string · requis
Bot API key with 'nrn_' prefix for authenticationsendAt· string · optionnel
ISO 8601 date-time for scheduled delivery (e.g., '2025-12-31T10:00:00Z'). Message sends immediately if omitted.message· string · requis
The message text to send to the recipientmediaUrl· string · optionnel
Public URL of the media file to attach (required for non-text message types)channelId· string · optionnel
Unique identifier (UUID) of a specific WhatsApp channel to send from. Uses the bot's primary channel if omitted.messageType· string · optionnel
Type of message to send: 'text', 'image', 'video', 'audio', or 'document' (default: 'text')
Exemple d'appel{"name": "neuron_bot_api_send", "arguments": {"to": "texte", "apiKey": "texte", "message": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_browse_list_pool≈ 276 tokens
Browse verified contact lists available in the shared marketplace pool. Filter by category, region, or search term.
Paramètres, retour & exemple (6)
Paramètrespage· number · optionnel
Page number for pagination (default: 1)limit· number · optionnel
Number of items per page (default: 20)region· string · optionnel
Filter by geographic region (e.g., 'lagos', 'abuja')search· string · optionnel
Search term to filter by description or categorycategory· string · optionnel
Filter by audience category (e.g., 'delivery', 'tech', 'consumers')smsEnabled· boolean · optionnel
Only return lists whose owner opted into SMS campaigns (usable as curated audiences for neuron_create_sms_campaign)
Exemple d'appel{"name": "neuron_browse_list_pool", "arguments": {"page": 1, "limit": 1, "region": "texte", "search": "texte", "category": "texte", "smsEnabled": true}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_browse_pool≈ 296 tokens
Browse the shared marketplace pool of published bots, tools, knowledge bases, and reflections with optional filtering by type, category, tags, or search query.
Paramètres, retour & exemple (7)
Paramètrespage· number · optionnel
Page number for pagination (default: 1)tags· string · optionnel
Filter by tags (comma-separated list, e.g., 'ai,chatbot')type· string · optionnel · knowledge_base | bot_template | tool_template | reflection_pack
Filter by resource typelimit· number · optionnel
Number of items per page (default: 20)query· string · optionnel
Free-text search query to filter pool items by name or descriptioncategory· string · optionnel
Filter by category namefeatured· boolean · optionnel
When true, return only featured items
Exemple d'appel{"name": "neuron_browse_pool", "arguments": {"page": 1, "tags": "texte", "type": "knowledge_base", "limit": 1, "query": "texte", "category": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_build_persona≈ 262 tokens
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).
Paramètres, retour & exemple (3)
Paramètresname· string · optionnel
Persona name. Defaults to '<collection name> voice'.sampleLimit· integer · optionnel
How many top-engagement items to analyze (default 40).collectionId· string · requis
Source Collection UUID (built by the web agent / content mining).
Exemple d'appel{"name": "neuron_build_persona", "arguments": {"collectionId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_build_persona_from_conversation≈ 332 tokens
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.
Paramètres, retour & exemple (6)
Paramètresname· string · optionnellimit· integer · optionnel
How many recent messages to read (default 200).author· string · optionnel · me | contact | bot | any
Whose voice to capture. Default 'me'.senderName· string · optionnel
For groups: match one participant by display name.senderPhone· string · optionnel
For groups: match one participant by phone.conversationId· string · requis
Conversation UUID (from neuron_list_conversations).
Exemple d'appel{"name": "neuron_build_persona_from_conversation", "arguments": {"conversationId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_build_persona_from_text≈ 400 tokens
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).
Paramètres, retour & exemple (7)
Paramètresname· string · optionnel
Persona name. Defaults to '<author> voice' or 'Custom voice'.text· string · optionnel
A raw blob to distill: posts, a dialogue, a chat transcript, or a writing sample. Auto-split into samples.samples· array · optionnel
Pre-split writing samples (alternative or addition to `text`).speaker· string · optionnel
If `text` is a chat transcript, keep only this speaker's lines (name match) — so a group chat yields one person's voice.platform· string · optionnel
Optional metadata tag for the samples (e.g. 'whatsapp', 'x').authorLabel· string · optionnel
Who the voice belongs to, for a more grounded analysis.description· string · optionnel
Exemple d'appel{"name": "neuron_build_persona_from_text", "arguments": {"name": "texte", "text": "texte", "samples": [], "speaker": "texte", "platform": "texte", "authorLabel": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_bulk_toggle_builtin_tools≈ 258 tokens
Enable or disable multiple built-in tools at once for a bot. More efficient than toggling tools individually.
Paramètres, retour & exemple (2)
ParamètresbotId· string · requis
Unique identifier (UUID) of the bot to update tools forsettings· array · requis
Array of tool toggle settings to apply in bulk
Exemple d'appel{"name": "neuron_bulk_toggle_builtin_tools", "arguments": {"botId": "texte", "settings": []}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_campaign_marketplace≈ 171 tokens
Browse available campaigns in the marketplace that your organization can join to earn rewards by sending messages.
Paramètres, retour & exemple (2)
Paramètrespage· integer · optionnel
Page number for pagination (default: 1)limit· integer · optionnel
Number of campaigns per page (default: 20)
Exemple d'appel{"name": "neuron_campaign_marketplace", "arguments": {"page": 1, "limit": 1}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_campaign_participants≈ 143 tokens
Retrieve all participants who have joined a campaign you own, including their delivery counts and earned rewards.
Paramètres, retour & exemple (1)
Paramètresid· string · requis
Unique identifier (UUID) of the campaign you own
Exemple d'appel{"name": "neuron_campaign_participants", "arguments": {"id": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_cancel_approval≈ 192 tokens
Cancel a still-pending approval (e.g. the upstream action was aborted). Fires the approval.cancelled callback. Requires a bot API key.
Paramètres, retour & exemple (3)
ParamètresapiKey· string · requis
Bot API key with 'nrn_' prefix for authenticationreason· string · optionnel
Optional cancellation reasonapprovalId· string · requis
The approval request id (UUID) to cancel
Exemple d'appel{"name": "neuron_cancel_approval", "arguments": {"apiKey": "texte", "approvalId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_cancel_booking≈ 140 tokens
Cancel a confirmed or pending booking. Sends cancellation notifications to the invitee.
Paramètres, retour & exemple (2)
Paramètresid· string · requis
Booking UUIDreason· string · optionnel
Cancellation reason
Exemple d'appel{"name": "neuron_cancel_booking", "arguments": {"id": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_cancel_flow_run≈ 129 tokens
Cancel a running or waiting flow execution. Steps already completed are not rolled back.
Paramètres, retour & exemple (1)
ParamètresrunId· string · requis
UUID of the run to cancel.
Exemple d'appel{"name": "neuron_cancel_flow_run", "arguments": {"runId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_cancel_scheduled_message≈ 154 tokens
Cancel a scheduled message to prevent it from being sent. Only messages with status 'scheduled' can be cancelled. This action cannot be undone.
Paramètres, retour & exemple (1)
Paramètresid· string · requis
Unique identifier (UUID) of the scheduled message to cancel
Exemple d'appel{"name": "neuron_cancel_scheduled_message", "arguments": {"id": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_cancel_subscription≈ 110 tokens
Cancel the current active subscription. Access continues until the end of the current billing period.
Paramètres, retour & exemple (0)
Exemple d'appel{"name": "neuron_cancel_subscription", "arguments": {}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_checkout≈ 151 tokens
Initiate a checkout session for a subscription plan upgrade. Returns a checkout URL or confirmation to complete the purchase.
Paramètres, retour & exemple (1)
Paramètresplan· string · requis · pro | business
Subscription plan to purchase: 'pro' or 'business'
Exemple d'appel{"name": "neuron_checkout", "arguments": {"plan": "pro"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_clear_chat≈ 418 tokens
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.
Paramètres, retour & exemple (7)
Paramètresexecute· boolean · optionnel
Actually clear. Default false = preview only.chatKind· string · optionnel · all | dm | group
DMs, groups, or both (default both).mediaTypes· array · optionnel
Only these media types (media clears only).confirmChats· integer · optionnel
Required for workspace-wide clears: the 'conversations' number from the preview.alsoBotMemory· boolean · optionnel
Also clear what the bot learned from these chats (insights, conversation summary).olderThanDays· ? · optionnel
Only messages older than this many days. Omit/null for all ages.conversationIds· array · optionnel
Limit to these conversations. Omit for the whole workspace.
Exemple d'appel{"name": "neuron_clear_chat", "arguments": {"execute": true, "chatKind": "all", "mediaTypes": [], "confirmChats": 1, "alsoBotMemory": true, "olderThanDays": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_clear_media≈ 336 tokens
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).
Paramètres, retour & exemple (5)
Paramètresexecute· boolean · optionnel
Actually remove. Default false = preview only.chatKind· string · optionnel · all | dm | group
DMs, groups, or both (default both).mediaTypes· array · optionnel
Only these media types (media clears only).olderThanDays· ? · optionnel
Only messages older than this many days. Omit/null for all ages.conversationIds· array · optionnel
Limit to these conversations. Omit for the whole workspace.
Exemple d'appel{"name": "neuron_clear_media", "arguments": {"execute": true, "chatKind": "all", "mediaTypes": [], "olderThanDays": "texte", "conversationIds": []}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_close_conversation≈ 143 tokens
Close an active conversation, marking it as completed. The bot will stop responding and the conversation is archived.
Paramètres, retour & exemple (1)
Paramètresid· string · requis
Unique identifier (UUID) of the conversation to close
Exemple d'appel{"name": "neuron_close_conversation", "arguments": {"id": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_complete_booking≈ 122 tokens
Mark a confirmed booking as completed (e.g. after the meeting has happened).
Paramètres, retour & exemple (1)
Paramètresid· string · requis
Booking UUID
Exemple d'appel{"name": "neuron_complete_booking", "arguments": {"id": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_compose_message≈ 525 tokens
Compose and send a new message to a phone number via a specific channel. Automatically creates a new conversation if one does not exist.
Paramètres, retour & exemple (8)
Paramètresto· string · requis
Recipient phone number (E.164 format, e.g., '2348012345678')text· string · optionnel
Message text content (optional when sending a template)sendAt· string · optionnel
ISO 8601 date-time for scheduled delivery (e.g., '2025-12-31T10:00:00Z'). Message sends immediately if omitted.mediaUrl· string · optionnel
URL of media to attach (required for non-text message types)template· object · optionnel
Approved template (official WhatsApp Business API sessions only). Required to reach anyone who hasn't messaged you in the last 24 hours. Set messageType to 'template'.channelId· string · requis
Unique identifier (UUID) of the WhatsApp channel to send throughcontactName· string · optionnel
Display name for the recipient contactmessageType· string · optionnel
Type of message: 'text' (default), 'image', 'document', or 'template' (official API sessions)
Exemple d'appel{"name": "neuron_compose_message", "arguments": {"to": "texte", "channelId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_confirm_booking≈ 120 tokens
Confirm a pending booking. Only works on bookings with status 'pending'.
Paramètres, retour & exemple (1)
Paramètresid· string · requis
Booking UUID
Exemple d'appel{"name": "neuron_confirm_booking", "arguments": {"id": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_convert_lead≈ 160 tokens
Promote a phone-bearing lead into a contact (so it can be messaged / added to lists). Optionally add the new contact to a list.
Paramètres, retour & exemple (2)
Paramètresid· string · requis
Lead UUIDaddToList· string · optionnel
Contact list name to add the converted contact to.
Exemple d'appel{"name": "neuron_convert_lead", "arguments": {"id": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_create_ad_request≈ 394 tokens
Create an ad distribution request to send a message to contacts in pool lists matching target demographics. Deducts from wallet upon approval.
Paramètres, retour & exemple (6)
Paramètresbudget· number · requis
Total ad budget in kobo (e.g., 500000 = NGN 5,000)message· string · requis
The ad message content to distribute to matched contactsmediaUrl· string · optionnel
Media URL for non-text messages (required when messageType is 'image', 'video', or 'document')targetGoal· number · requis
Target number of successful message deliveriesmessageType· string · optionnel
Message content type: 'text', 'image', 'video', or 'document' (default: 'text')targetDemographics· object · requis
Demographic criteria to match against pool list entries
Exemple d'appel{"name": "neuron_create_ad_request", "arguments": {"budget": 1, "message": "texte", "targetGoal": 1, "targetDemographics": {}}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_create_api_key≈ 222 tokens
Create a new API key for programmatic access to a specific bot. Store the key securely as it cannot be retrieved later.
Paramètres, retour & exemple (3)
Paramètresname· string · requis
Descriptive name for the API key to identify its purpose (e.g., 'Production CRM Integration')botId· string · requis
Unique identifier (UUID) of the bot to create the API key forexpiresAt· string · optionnel
ISO 8601 date-time when the key should expire (e.g., '2026-12-31T23:59:59Z'). Key never expires if omitted.
Exemple d'appel{"name": "neuron_create_api_key", "arguments": {"name": "texte", "botId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_create_blog_post≈ 900 tokens
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.
Paramètres, retour & exemple (11)
Paramètrestags· array · optionnel
List of tag names or slugs to categorize the posttitle· string · requis
Title of the blog post (max 500 characters)blocks· array · optionnel
Structured layout blocks, rendered top-to-bottom as styled components. Each block is an object with a `type` and its fields: - hero: { type:'hero', title, kicker?, subtitle?, imageUrl?, align?:'left'|'center', ctaLabel?, ctaHref? } - richText: { type:'richText', markdown } (full GFM markdown) - callout: { type:'callout', variant:'info'|'tip'|'warning'|'success'|'danger', title?, markdown } - columns: { type:'columns', ratio?:'1-1'|'1-2'|'2-1', columns:[ [block,...], [block,...] ] } (exactly 2 columns of leaf blocks; no nested columns) - codeCard: { type:'codeCard', language?, filename?, code } - imageGrid: { type:'imageGrid', columns?:1|2|3|4, images:[{ url, alt?, caption? }] } - quote: { type:'quote', quote, attribution? } - embed: { type:'embed', provider:'youtube'|'loom'|'vimeo'|'generic', url, title? } (paste the normal share URL) - cta: { type:'cta', headline, body?, buttonLabel, buttonHref, secondaryLabel?, secondaryHref?, accent?:'#hex' } - divider: { type:'divider' } - html: { type:'html', html, sandboxed?, height? } (custom HTML. Default is sanitized + indexable, no scripts. Set sandboxed:true to run scripts inside an isolated iframe — NOT indexed by search.) Build magazine-style posts by composing these, e.g. a hero, then richText, then a columns block, a callout, a codeCard, and a closing cta.status· string · optionnel · draft | published
Initial publication status of the post (default: 'draft')content· string · optionnel
Optional markdown body (GFM + inline raw HTML). Used when `blocks` is not provided, and kept as a fallback when it is. Rich options: , <video src controls>, <iframe> embeds (16:9), <details><summary>, <mark>, <kbd>.excerpt· string · optionnel
Short summary or preview text for the blog postseoTitle· string · optionnel
Custom SEO title override for search engine resultsauthorType· string · requis · user | organization
Whether the post is authored by an individual user or the organizationseoKeywords· array · optionnel
List of SEO keywords for search engine optimizationcoverImageUrl· string · optionnel
URL of the cover image displayed at the top of the postseoDescription· string · optionnel
Meta description for search engine result snippets
Exemple d'appel{"name": "neuron_create_blog_post", "arguments": {"title": "texte", "authorType": "user"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_create_bot≈ 962 tokens
Create a new AI bot with specified name, model, and behavior instructions. Returns the created bot object.
Paramètres, retour & exemple (16)
Paramètresname· string · requis
Display name for the botllmModel· string · optionnel
OpenRouter model ID (e.g., 'deepseek/deepseek-v4.1-flash' (default), 'google/gemini-2.5-flash')metadata· object · optionnel
Arbitrary metadata object stored with the bot. Known keys: 'communityExitFollowUp' (auto-DM users who leave watched groups — { enabled: boolean, groupJids: string[], message: string with {name} placeholder }), 'learningConfig' (self-learning from conversations — { enabled: boolean, folder: string, groupChats: string[], dmPhones: string[], useAdminPhones: boolean }), 'loadBalancing' (multi-channel round-robin — { enabled: boolean, strategy: string }), 'welcomeNewMembers' (fine-tune welcome behavior — { batchWindowSeconds: number, groupJids: string[] }). Additional custom keys are preserved as-is.maxTokens· number · optionnel
Maximum number of tokens the bot can generate per responseassignment· string · optionnel
One-sentence role definition for the bot (max 2000 chars)systemPrompt· string · requis
System prompt that defines the bot's behavior, personality, and response guidelinesthrottleMode· string · optionnel · hold | drop
While paused: 'hold' (default) queues sends and delivers them when safe — the bot API returns success with throttle.status 'held'; 'drop' refuses them — the bot API returns 429 THROTTLED with Retry-After.llmTemperature· number · optionnel
Temperature parameter controlling response randomness (0 = deterministic, 2 = creative)welcomeMessage· string · optionnel
Welcome message sent to new members joining groups the bot manages. Setting this field activates the batched welcome feature — new members are accumulated over a window (default 60s) and welcomed in a single message with @mentions. Set to null to disable.fallbackMessage· string · optionnel
Message sent when the bot cannot understand user input (max 2000 chars)greetingMessage· string · optionnel
Automatic greeting sent when a new conversation starts (max 2000 chars)throttleEnabled· boolean · optionnel
"Protect my number": slow down, then pause, the bot's proactive WhatsApp sends (API, flows, tasks) when the number nears volume that gets numbers suspended, and resume automatically. Replies to inbound messages are never held. WhatsApp doesn't publish its limits: these are conservative estimates that cut the risk but can't guarantee no suspension; content and spam reports matter as much as volume.escalationPrompt· string · optionnel
Prompt template used when escalating to a human agent (max 5000 chars)responsibilities· array · optionnel
Array of responsibility descriptions defining what the bot handlesthrottleHoldHours· integer · optionnel
Hold mode: give up on a held message after this many hours (default 24); it then appears under failed messages.whatsappChannelId· string · optionnel
Unique identifier (UUID) of the WhatsApp channel to associate with the bot
Exemple d'appel{"name": "neuron_create_bot", "arguments": {"name": "texte", "systemPrompt": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_create_broadcast≈ 918 tokens
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.
Paramètres, retour & exemple (10)
Paramètresname· string · requis
Display name or label for the broadcastbotId· string · optionnel
Identifier (UUID) of a bot to send through. Each recipient's channel is picked by the bot's load-balancer + sticky sessions. Takes precedence over channelId.message· string · optionnel
Message content to broadcast to recipients (optional when sending a template)mediaUrl· string · optionnel
URL of media to attach (required for image or document message types)template· object · optionnel
Approved template (official WhatsApp Business API sessions only). On official API sessions, use one for broadcasts: most recipients won't have messaged you in the last 24 hours, and only templates reach them. Set messageType to 'template'.channelId· string · optionnel
Identifier (UUID) of the WhatsApp channel to send through (auto-resolved from default channel if omitted)recipients· array · optionnel
Direct list of recipients (alternative to recipientSources)messageType· string · optionnel
Type of message to send (e.g., 'text', 'image', 'document', or 'template' on official API sessions)scheduledAt· string · optionnel
ISO 8601 date-time for scheduled broadcast delivery (e.g., '2025-12-31T10:00:00Z'). Creates as draft if omitted.recipientSources· object · optionnel
Resolve recipients dynamically from contact lists with filtering and exclusion
Exemple d'appel{"name": "neuron_create_broadcast", "arguments": {"name": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_create_calendar≈ 354 tokens
Create a new booking calendar with a name, timezone, and visibility setting.
Paramètres, retour & exemple (10)
Paramètresname· string · requis
Calendar display nameslug· string · optionnel
URL slug (auto-generated from name if omitted)color· string · optionnel
Hex color code (e.g. '#6366f1')timezone· string · optionnel
IANA timezone (default: Africa/Lagos)visibility· string · optionnel · private | public | org-link
Visibility: 'public' for public booking page, 'org-link' for link-only, 'private' for no public accessdescription· string · optionnel
Calendar descriptionnotifyEmail· boolean · optionnel
Send email notifications for bookingsnotifyPhone· string · optionnel
Host phone number for WhatsApp notificationsnotifyWhatsapp· boolean · optionnel
Send WhatsApp notifications for bookingsnotifyEmailAddress· string · optionnel
Host email address for notifications
Exemple d'appel{"name": "neuron_create_calendar", "arguments": {"name": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_create_campaign≈ 360 tokens
Create a new outreach campaign with target audience, messaging template, and schedule configuration. Requires a Pro or Business plan.
Paramètres, retour & exemple (8)
Paramètrestitle· string · requis
Campaign title displayed in marketplace and dashboardmessage· string · requis
The WhatsApp message template to send to contactsdeadline· string · requis
Campaign deadline in ISO 8601 date format (e.g., '2025-12-31')guidelines· string · optionnel
Instructions and guidelines for campaign participantsdescription· string · optionnel
Campaign description shown in the marketplace listingtotalBudget· number · requis
Total campaign budget in kobo (e.g., 500000 = NGN 5,000)rewardPerDelivery· number · requis
Reward per successful delivery in kobo (e.g., 5000 = NGN 50)requireMutualContact· boolean · optionnel
Only allow sends to contacts who have previously responded (default: false)
Exemple d'appel{"name": "neuron_create_campaign", "arguments": {"title": "texte", "message": "texte", "deadline": "texte", "totalBudget": 1, "rewardPerDelivery": 1}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_create_channel≈ 278 tokens
Create a new WhatsApp channel with either Meta Cloud API or Baileys (direct WhatsApp) integration. Meta Cloud channels require metaPhoneNumberId and metaAccessToken.
Paramètres, retour & exemple (5)
Paramètresname· string · requis
Display name for the channeltype· string · requis · meta_cloud | baileys
Integration type: 'meta_cloud' for Meta Cloud API or 'baileys' for direct WhatsApp connectionphoneNumber· string · optionnel
Phone number for the channel (E.164 format, e.g., '+2348012345678')metaAccessToken· string · optionnel
Meta Access Token (required for meta_cloud type)metaPhoneNumberId· string · optionnel
Meta Phone Number ID (required for meta_cloud type)
Exemple d'appel{"name": "neuron_create_channel", "arguments": {"name": "texte", "type": "meta_cloud"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_create_contact≈ 320 tokens
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.
Paramètres, retour & exemple (7)
Paramètresname· string · requis
Full name of the contacttags· array · optionnel
Tags to categorize the contact (e.g., ['vendor', 'lagos'])email· string · optionnel
Email address of the contactnotes· string · optionnel
Additional notes about the contact, saved as a structured entryphone· string · requis
Contact phone number in E.164 format (e.g., +2348012345678)doNotBroadcast· boolean · optionnel
If true, this contact is permanently excluded from all broadcastsdoNotAutoRespond· boolean · optionnel
If true, the bot will never auto-respond to this contact (manual/API and human sends still work)
Exemple d'appel{"name": "neuron_create_contact", "arguments": {"name": "texte", "phone": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_create_contact_list≈ 312 tokens
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.
Paramètres, retour & exemple (6)
Paramètresname· string · requis
Display name for the contact listslug· string · optionnel
URL-friendly identifier (auto-generated from name if omitted)type· string · optionnel · static | dynamic | merged
List type (default: 'static')criteria· object · optionnel
Dynamic list criteria object: { rules?: { operator, conditions }, aiPrompt?, aiMaxResults? }description· string · optionnel
Human-readable description of the list's purposerefreshSchedule· string · optionnel · manual | daily | weekly | on_access
Refresh schedule for dynamic lists (default: 'manual')
Exemple d'appel{"name": "neuron_create_contact_list", "arguments": {"name": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_create_event≈ 743 tokens
Create a host-initiated event on a calendar. Supports attendees (with WhatsApp/email invitations), location, and daily/weekly/monthly recurrence.
Paramètres, retour & exemple (9)
Paramètrestitle· string · requis
Event titleendTime· string · requis
End time (ISO 8601)attendees· array · optionnel
List of attendees to invitestartTime· string · requis
Start time (ISO 8601, e.g. '2025-03-15T09:00:00Z')calendarId· string · requis
Calendar UUIDdescription· string · optionnel
Event descriptionlocationType· string · optionnel · video | phone | in_person | whatsapp | custom
Location typelocationValue· string · optionnel
Location detailsrecurrenceRule· ? · optionnel
Recurrence rule — generates instances 12 weeks ahead
Exemple d'appel{"name": "neuron_create_event", "arguments": {"title": "texte", "endTime": "texte", "startTime": "texte", "calendarId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_create_event_type≈ 488 tokens
Create a bookable event type on a calendar (e.g. '30-min consultation').
Paramètres, retour & exemple (16)
Paramètresname· string · requis
Event type name (e.g. 'Discovery Call')color· string · optionnel
Hex color codeprice· number · optionnel
Price for paid bookingscurrency· string · optionnel
3-letter currency code (e.g. 'NGN')duration· number · optionnel
Duration in minutes (default: 30)minNotice· number · optionnel
Minimum notice in minutes before bookingcalendarId· string · requis
Calendar UUID to add the event type tomaxAdvance· number · optionnel
Maximum advance booking in minutesbufferAfter· number · optionnel
Buffer minutes after each bookingdescription· string · optionnel
Description shown on the booking pagebufferBefore· number · optionnel
Buffer minutes before each bookinglocationType· string · optionnel · video | phone | in_person | whatsapp | custom
Meeting location typeslotInterval· number · optionnel
Slot interval in minutes (default: 15)locationValue· string · optionnel
Location details (URL, address, phone)reminderMinutes· array · optionnel
Array of reminder times in minutes before event (e.g. [1440, 60])requireConfirmation· boolean · optionnel
Require host confirmation for new bookings
Exemple d'appel{"name": "neuron_create_event_type", "arguments": {"name": "texte", "calendarId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_create_flow≈ 1210 tokens
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.conditions it is a raw payload path (e.g. 'text'). AFTER SAVING: the flow always saves, but the response includes a `warnings` array flagging likely bugs (unknown node type, missing required field, malformed conditions/cases/assignments, edges wired to a handle a node never emits, missing trigger). Always check it and fix any warnings — a warning means that part will silently no-op at run time. TEMPLATE RESOLUTION: Node config values support {{…}} templates resolved at runtime: {{trigger.text}} — the triggering message text {{trigger.contactPhone}} — the sender's phone {{trigger.senderName}} — the sender's name {{vars.myVar}} — a variable set by logic.set_variable {{nodes.n_abc.output.text}} — output from a previous node {{= amount * 1.1 }} — inline expression (arithmetic, comparisons, ternary) ERROR HANDLING: Any node's config can include __errorHandling: { continueOnFail: true, retryCount: 3, retryDelayMs: 1000 } to retry on failure with exponential backoff and/or continue on the 'error' handle instead of failing the run. WIRING RULES: - logic.branch: 'true' and 'false' handles - logic.switch / logic.ai_router: one handle per case id, plus 'default' - logic.wait_for_reply: 'default' (replied) and 'timeout' - logic.wait_for_approval: 'approved', 'rejected', 'timeout' - logic.wait_first_of: 'reply', 'event', 'timeout' - logic.loop: 'loop' (body) and 'done' - action.lookup_contact: 'found' and 'not_found' - action.call_flow: 'default' (returned), 'timeout', 'error' - All other nodes: 'default' handle (or 'error' when continueOnFail is on)
Paramètres, retour & exemple (4)
Paramètresname· string · requis
Human-readable name for the flow.graph· object · optionnel
The flow graph — nodes and edges. Omit to create an empty flow (edit later in the UI).enabled· boolean · optionnel
Whether the flow should be active immediately (default: false).description· string · optionnel
Optional description of what the flow does.
Exemple d'appel{"name": "neuron_create_flow", "arguments": {"name": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_create_group≈ 550 tokens
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.
Paramètres, retour & exemple (12)
Paramètresslug· string · optionnel
Optional org-unique handle (lowercase letters, numbers, hyphens)tags· array · optionnel
Keep only contacts carrying one of these tagsphones· array · optionnel
Raw phone numbers, e.g. pasted from a CSVlistIds· array · optionnel
Contact list ids or slugs — pulls every membersubject· string · requis
Group nameifExists· string · optionnel · return | error
When the slug is already taken: 'error' (default) fails, 'return' returns the existing group and adds any given members to it (idempotent create).channelId· string · optionnel
Session (connected WhatsApp number) UUID. Omit to use the default.contactIds· array · optionnel
Existing contact idsallContacts· boolean · optionnel
Union the org's entire address bookdescription· string · optionnel
Optional group descriptionfromGroupIds· array · optionnel
Copy/combine members live from these WhatsApp group JIDsexcludeListIds· array · optionnel
Subtract every member of these lists
Exemple d'appel{"name": "neuron_create_group", "arguments": {"subject": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_create_instagram_list≈ 154 tokens
Create an Instagram list. Names are unique per organization (case-insensitive).
Paramètres, retour & exemple (2)
Paramètresname· string · requis
List name, e.g. 'Giveaway entrants'description· string · optionnel
Exemple d'appel{"name": "neuron_create_instagram_list", "arguments": {"name": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_create_kb_entry≈ 332 tokens
Add a new entry (note, document, or information piece) to a knowledge base.
Paramètres, retour & exemple (7)
Paramètresid· string · requis
Unique identifier of the knowledge basetitle· string · requis
Title of the entryfolder· string · optionnel
Folder to organize the entry: 'general', 'skills', 'contexts', 'documents', or 'faqs' (default: general)source· string · optionnel · manual | document | url
Source type of the entry (default: manual)content· string · requis
Content or body of the entrymetadata· object · optionnel
Optional metadata key-value pairs for the entryexpiresAt· string|null · optionnel
When the entry stops being true (ISO 8601 with offset, e.g. 2026-10-16T23:59:59+05:00). The bot ignores it afterwards and it is deleted within the hour. Null clears it.
Exemple d'appel{"name": "neuron_create_kb_entry", "arguments": {"id": "texte", "title": "texte", "content": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_create_knowledge_base≈ 186 tokens
Create a new knowledge base to store and organize information, documents, and entries.
Paramètres, retour & exemple (3)
Paramètresname· string · requis
Name of the knowledge basedescription· string · optionnel
Optional description of the knowledge base purposerootInstruction· string · optionnel
Optional root instruction or context for the knowledge base
Exemple d'appel{"name": "neuron_create_knowledge_base", "arguments": {"name": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_create_lead_source≈ 344 tokens
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}).
Paramètres, retour & exemple (7)
Paramètresname· string · requistype· string · requis · csv | text_paste | document | web_scrape | tool_output | instagram | x | facebook
Lead source type. facebook = Meta Ads Library advertisers; web/IG/X/FB scraping needs DeepAPI configured; TikTok has no native provider (use tool_output).config· object · optionnelenabled· boolean · optionnelschedule· object · optionneltimezone· string · optionnelscheduleKind· string · optionnel · cron | interval | once | manual
Exemple d'appel{"name": "neuron_create_lead_source", "arguments": {"name": "texte", "type": "csv"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_create_list_campaign≈ 1626 tokens
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).
Paramètres, retour & exemple (11)
Paramètresname· string · optionnel
Campaign name (default: 'Campaign')botId· ? · optionnel
Bot to send through when sendMode='bot'; its channel is usedlistId· string · requis
The contact list to run the campaign overschedule· ? · requis
When each batch fires. e.g. daily at 9am in Africa/Lagos, or every weekend.sendMode· string · optionnel · message | bot
'message' sends a plain broadcast; 'bot' initiates the conversation through a bot (default: 'message')batchSize· integer · optionnel
How many contacts to message per run (default: 20)channelId· ? · optionnel
WhatsApp channel to send from; falls back to the org default / first connected channelonExhaust· string · optionnel · stop | loop
When the whole list has been reached: 'stop' (default) completes the campaign; 'loop' starts a new cycle after loopCooldownMsmessageSource· ? · requis
How the message is resolved live at each batch run: 'static' (fixed), 'rotation' (cycle through several), 'ai' (AI-written), 'webhook' (from your service), or 'content' (a saved Neuron Note).loopCooldownMs· ? · optionnel
Milliseconds to wait before looping (default: 24h)startImmediately· boolean · optionnel
Fire the first batch right away (default: true). Set false to wait for the first scheduled slot
Exemple d'appel{"name": "neuron_create_list_campaign", "arguments": {"listId": "texte", "schedule": "texte", "messageSource": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_create_newsletter≈ 210 tokens
Create a new WhatsApp Channel newsletter for one-way broadcast updates. Requires a connected Baileys session on the specified channel.
Paramètres, retour & exemple (3)
Paramètresname· string · requis
Display name of the newsletter visible to subscriberschannelId· string · requis
Identifier (UUID) of the WhatsApp session channel to create the newsletter ondescription· string · optionnel
Description of the newsletter's purpose and content
Exemple d'appel{"name": "neuron_create_newsletter", "arguments": {"name": "texte", "channelId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_create_outbound_webhook≈ 383 tokens
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.
Paramètres, retour & exemple (5)
Paramètresurl· string · requis
Destination URL that will receive webhook event payloads (HTTPS recommended)name· string · requis
Human-readable name for the outbound webhookbotId· string · requis
Unique identifier (UUID) of the bot to create the outbound webhook foreventTypes· array · requis
Array of event types that should trigger this webhookfilterPrompt· string · optionnel
Optional LLM prompt to selectively filter which events are forwarded (e.g., 'only forward escalations about billing')
Exemple d'appel{"name": "neuron_create_outbound_webhook", "arguments": {"url": "texte", "name": "texte", "botId": "texte", "eventTypes": []}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_create_product≈ 1794 tokens
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.
Paramètres, retour & exemple (32)
Paramètreskind· string|null · optionnel
Short label e.g. 'E-book', 'Presets', 'Service'codes· array · optionnel
For codeMode 'pool': the unique codes/keys to add (one gets sent per buyer). Appended to any existing pool.theme· object · optionnel
Per-product theme: { bg, accent, text (hex), mode: 'light'|'dark', layout: 'hero'|'side', coverAspect: '16/10'|'3/2'|'1/1'|'4/5', cta: buy-button label e.g. 'Reserve your hour' }title· string · requis
Product title shown to buyerscontent· array · optionnel
Rich product-page content blocks. Ordered array of {type, ...}: heading {text,level}, text {markdown}, image {url,caption}, video {url}, callout {emoji,text}, collapsible {title,blocks[]}, divider {}, button {label,url}, embed {url}, spacer {}enabled· boolean · optionnel
Whether the product is livecategory· string|null · optionnel
Category label e.g. 'Productivity'codeMode· string · optionnel · shared | pool | generated
For deliveryType 'code': 'shared' (same text to every buyer), 'pool' (a unique code per sale from codes you upload — sells out when empty), or 'generated' (auto-mint a unique license key per sale)currency· string · optionnel
ISO currency (default NGN)feePayer· string · optionnel · buyer | seller
'buyer' (fee added on top, seller gets full price — default) or 'seller' (fee deducted)channelId· ? · optionnel
WhatsApp session UUID used to deliver the product (defaults to the org default channel)coverType· string · optionnel · none | emoji | image | color | gradient
How the cover rendersemailBody· ? · optionnel
Custom message for the buyer's delivery email: plain text (no HTML), blank line = new paragraph, **bold**, links auto-linked, same variables as emailSubject. The download button / link / code is always added below it automatically. Null = the default message.coverColor· string|null · optionnel
Cover colour (hex) for 'color'/'gradient' cover typescoverEmoji· string|null · optionnel
Emoji used as a cover fallback (e.g. 📓)membership· boolean · optionnel
Make this a recurring subscription/membership: it tracks a paid period per buyer, renews from their Neuron wallet when possible (else emails a reminder — no card auto-charge), and marks them lapsed when the period + grace passes. React to membership.started/renewed/lapsed in Flows to deliver whatever the membership grants.priceMinor· integer · requis
Current price (charged). Amount in kobo (minor units): ₦1 = 100. Minimum ₦500 = 50000. Set 0 for a free product (no payment).coverColor2· string|null · optionnel
Second colour (hex) for 'gradient' coverdescription· string · optionnel
Rich description / what the buyer getsdeliveryText· string|null · optionnel
For 'link'/'code': the link or code the buyer receives. Optional note for 'file'.deliveryType· string · requis · file | link | code
How the product is delivered: 'file' (uploaded file), 'link' (URL), or 'code' (text/code)emailSubject· ? · optionnel
Custom subject for the buyer's delivery email. Variables: {{buyer_first_name}}, {{buyer_name}}, {{product_title}}, {{store_name}}, {{access_link}}, {{code}}, {{order_ref}}. Null = default ('Your {{product_title}} is ready').coverImageUrl· ? · optionnel
Cover image URLcheckoutFields· array · optionnel
Custom checkout questions the buyer answers (name, address, specs/customisations…). Their answers are attached to the order and sent to the seller.deliveryChannel· string · optionnel · email | both
How buyers receive it. 'email' (default for new products): a branded email from your store only, with no WhatsApp needed and no ban risk on big launches. 'both': also sends from your connected WhatsApp, within the number's daily new-contact cap (buyers past the cap still get the email).deliveryFileUrl· ? · optionnel
For deliveryType 'file': the uploaded file URL (upload first with neuron_upload_media)deliveryFileName· string|null · optionnel
Filename shown on the download button and in the WhatsApp documentmembershipInterval· ? · optionnel
Billing period. Required when membership is true.originalPriceMinor· ? · optionnel
Optional compare-at / 'was' price (kobo), shown struck through. Must be ≥ current price.membershipGraceDays· integer · optionnel
Days after the period ends before an unpaid member lapses (and, if a group is attached, is removed from it). Default 1.membershipGroupName· string|null · optionnel
Group subject used when the attached group is auto-created (defaults to the product title). Only relevant with membershipGroupSlug.membershipGroupSlug· string|null · optionnel
OPTIONAL: attach a WhatsApp group as a membership perk. Org-unique handle (lowercase letters, numbers, hyphens); the group is created on the first sale, buyers are added on renewal and removed on lapse. Your connected number must be a group admin. Omit for a membership that isn't group-based.
Exemple d'appel{"name": "neuron_create_product", "arguments": {"title": "texte", "priceMinor": 1, "deliveryType": "file"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_create_sms_campaign≈ 591 tokens
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.
Paramètres, retour & exemple (10)
Paramètrestype· string · optionnel · blast | drip
'blast' sends to everyone at once (default); 'drip' sends in scheduled batchestitle· string · requis
Internal campaign titlebudget· number · optionnel
Budget in kobo (required for sourceType 'platform'; caps how many messages send)phones· array · optionnel
Raw phone numbers to text (required when sourceType is 'phones'); normalized + de-duplicated server-side, invalid ones droppedmessage· string · requis
The SMS text to send. Include an opt-out (e.g. 'Reply STOP').sourceType· string · requis · all_contacts | contact_list | phones | platform | curated
Audience sourcecountryCodes· array · optionnel
Restrict to these country calling codes (e.g. ['234']). Omit for all.poolEntryIds· array · optionnel
SMS-enabled list-pool entry UUIDs (required when sourceType is 'curated'; find them with neuron_browse_list_pool { smsEnabled: true })smsChannelId· string · optionnel
BYOK SMS channel UUID to send through instead of the platform providersourceListIds· array · optionnel
Contact list UUIDs (required when sourceType is 'contact_list')
Exemple d'appel{"name": "neuron_create_sms_campaign", "arguments": {"title": "texte", "message": "texte", "sourceType": "all_contacts"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_create_social_channel≈ 261 tokens
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.
Paramètres, retour & exemple (4)
Paramètreslabel· string · requis
Display name for the channel (e.g., 'Brand IG Account')platform· string · requis · instagram | twitter
Social media platform: 'instagram' or 'twitter'username· string · optionnel
Social media username (without @)credentials· string · optionnel
Session credentials as JSON string with account, session.cookies, session.headers, etc.
Exemple d'appel{"name": "neuron_create_social_channel", "arguments": {"label": "texte", "platform": "instagram"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_create_task≈ 632 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.
Paramètres, retour & exemple (8)
ParamètresbotId· string · requis
UUID of the bottitle· string · requis
Short title for the taskconfig· object · optionnel
Safety / execution config for the task.enabled· boolean · optionnel
Whether the task is active (default true).schedule· object · optionnel
Schedule payload matching scheduleKind. cron: { time: 'HH:MM', days?: number[] } (0=Sunday..6=Saturday; empty/omitted = every day). interval: { everyMinutes: number }. once: { runAt: ISO8601 string }. manual: {}.timezone· string · optionnel
IANA timezone (e.g. Africa/Lagos). Defaults to UTC.instruction· string · requis
What the task should do, in natural language (self-contained; preserve any exact message copy verbatim).scheduleKind· string · requis · cron | interval | once | manual
cron = recurring at a clock time (slot); interval = every N minutes; once = a single future moment; manual = only runs on demand.
Exemple d'appel{"name": "neuron_create_task", "arguments": {"botId": "texte", "title": "texte", "instruction": "texte", "scheduleKind": "cron"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_create_tool≈ 892 tokens
Create a custom API tool that the bot can invoke during conversations to fetch external data or trigger actions.
Paramètres, retour & exemple (8)
Paramètresname· string · requis
Human-readable name for the tooltype· string · requis · http_api | webhook | mcp
Type of the tool integrationbotId· string · requis
Unique identifier (UUID) of the bot to create the tool forconfig· object · requis
Tool configuration specifying the endpoint and request detailsauthType· string · optionnel · none | api_key | bearer | basic | oauth2
Authentication type for the endpointrateLimit· number · optionnel
Maximum number of requests per minute allowed for this tooltimeoutMs· number · optionnel
Request timeout in milliseconds (default: 30000)description· string · requis
Description of what the tool does and when the bot should use it
Exemple d'appel{"name": "neuron_create_tool", "arguments": {"name": "texte", "type": "http_api", "botId": "texte", "config": {}, "description": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_create_webhook≈ 286 tokens
Register a new inbound webhook endpoint that triggers bot actions when called by an external service.
Paramètres, retour & exemple (6)
Paramètresname· string · requis
Human-readable name for the webhookslug· string · optionnel
URL-friendly slug for the webhook endpoint (auto-generated if omitted)botId· string · requis
Unique identifier (UUID) of the bot to create the webhook forisActive· boolean · optionnel
Whether the webhook is active and accepting requests (default: true)eventType· string · optionnel
Type of event this webhook handles (e.g., 'order.created', 'payment.received')processingPrompt· string · optionnel
Prompt instructions to guide bot processing of incoming webhook data
Exemple d'appel{"name": "neuron_create_webhook", "arguments": {"name": "texte", "botId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_delete_ad_request≈ 141 tokens
Permanently delete a draft ad request. Only ad requests in draft status can be deleted.
Paramètres, retour & exemple (1)
ParamètresadRequestId· string · requis
Unique identifier (UUID) of the draft ad request to delete
Exemple d'appel{"name": "neuron_delete_ad_request", "arguments": {"adRequestId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_delete_blog_post≈ 130 tokens
Permanently delete a blog post by its ID. This action cannot be undone.
Paramètres, retour & exemple (1)
Paramètresid· string · requis
Unique identifier (UUID) of the blog post to delete
Exemple d'appel{"name": "neuron_delete_blog_post", "arguments": {"id": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_delete_bot≈ 128 tokens
Permanently delete a bot and all its associated data. This action cannot be undone.
Paramètres, retour & exemple (1)
Paramètresid· string · requis
Unique identifier (UUID) of the bot to delete
Exemple d'appel{"name": "neuron_delete_bot", "arguments": {"id": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_delete_broadcast≈ 133 tokens
Permanently delete a broadcast and its recipient data. This action cannot be undone.
Paramètres, retour & exemple (1)
Paramètresid· string · requis
Unique identifier (UUID) of the broadcast to delete
Exemple d'appel{"name": "neuron_delete_broadcast", "arguments": {"id": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_delete_calendar≈ 124 tokens
Permanently delete a calendar and all its event types, bookings, and availability data.
Paramètres, retour & exemple (1)
Paramètresid· string · requis
Calendar UUID
Exemple d'appel{"name": "neuron_delete_calendar", "arguments": {"id": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_delete_campaign≈ 138 tokens
Permanently delete a campaign that is in 'draft' status. Active or funded campaigns cannot be deleted.
Paramètres, retour & exemple (1)
Paramètresid· string · requis
Unique identifier (UUID) of the draft campaign to delete
Exemple d'appel{"name": "neuron_delete_campaign", "arguments": {"id": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_delete_channel≈ 136 tokens
Permanently delete a WhatsApp channel and disconnect any active sessions. This action cannot be undone.
Paramètres, retour & exemple (1)
Paramètresid· string · requis
Unique identifier (UUID) of the channel to delete
Exemple d'appel{"name": "neuron_delete_channel", "arguments": {"id": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_delete_contact≈ 135 tokens
Permanently delete a contact and remove them from all contact lists. This action cannot be undone.
Paramètres, retour & exemple (1)
Paramètresid· string · requis
Unique identifier (UUID) of the contact to delete
Exemple d'appel{"name": "neuron_delete_contact", "arguments": {"id": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_delete_contact_list≈ 148 tokens
Permanently delete a contact list. System-protected lists (e.g., 'Do Not Contact') cannot be deleted.
Paramètres, retour & exemple (1)
ParamètresidOrSlug· string · requis
Unique identifier (UUID) or URL-friendly slug of the contact list to delete
Exemple d'appel{"name": "neuron_delete_contact_list", "arguments": {"idOrSlug": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_delete_event≈ 182 tokens
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).
Paramètres, retour & exemple (2)
Paramètresid· string · requis
Event (booking) UUIDscope· string · optionnel · single | future | all
Delete scope for recurring events (default: 'single')
Exemple d'appel{"name": "neuron_delete_event", "arguments": {"id": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_delete_event_type≈ 117 tokens
Permanently delete an event type and all its bookings.
Paramètres, retour & exemple (1)
Paramètresid· string · requis
Event type UUID
Exemple d'appel{"name": "neuron_delete_event_type", "arguments": {"id": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_delete_flow≈ 139 tokens
Soft-delete a flow. It stops running but can be restored for 30 days with neuron_restore_deleted_flow. Running executions are not cancelled.
Paramètres, retour & exemple (1)
Paramètresid· string · requis
UUID of the flow to delete.
Exemple d'appel{"name": "neuron_delete_flow", "arguments": {"id": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_delete_flow_run≈ 128 tokens
Permanently delete a completed, failed, or cancelled flow run and all its step data.
Paramètres, retour & exemple (1)
ParamètresrunId· string · requis
UUID of the run to delete.
Exemple d'appel{"name": "neuron_delete_flow_run", "arguments": {"runId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_delete_instagram_list≈ 123 tokens
Delete an Instagram list and its members. Flows filtering on it stop matching anyone.
Paramètres, retour & exemple (1)
Paramètresid· string · requis
Exemple d'appel{"name": "neuron_delete_instagram_list", "arguments": {"id": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_delete_kb_entry≈ 152 tokens
Permanently delete a specific entry from a knowledge base.
Paramètres, retour & exemple (2)
ParamètreskbId· string · requis
Unique identifier of the knowledge baseentryId· string · requis
Unique identifier of the entry to delete
Exemple d'appel{"name": "neuron_delete_kb_entry", "arguments": {"kbId": "texte", "entryId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_delete_knowledge_base≈ 134 tokens
Permanently delete a knowledge base and all its associated entries and documents.
Paramètres, retour & exemple (1)
Paramètresid· string · requis
Unique identifier of the knowledge base to delete
Exemple d'appel{"name": "neuron_delete_knowledge_base", "arguments": {"id": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_delete_list_campaign≈ 134 tokens
Permanently delete a paced list campaign and its reached-set. Does not delete the contacts or the list.
Paramètres, retour & exemple (1)
Paramètresid· string · requis
Campaign ID
Exemple d'appel{"name": "neuron_delete_list_campaign", "arguments": {"id": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_delete_message≈ 158 tokens
Permanently delete a specific message from a conversation. This action cannot be undone.
Paramètres, retour & exemple (2)
Paramètresid· string · requis
Unique identifier (UUID) of the conversationmsgId· string · requis
Unique identifier (UUID) of the message to delete
Exemple d'appel{"name": "neuron_delete_message", "arguments": {"id": "texte", "msgId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_delete_newsletter≈ 140 tokens
Permanently delete a WhatsApp Channel newsletter and remove it from WhatsApp. This action cannot be undone.
Paramètres, retour & exemple (1)
Paramètresid· string · requis
Unique identifier (UUID) of the newsletter to delete
Exemple d'appel{"name": "neuron_delete_newsletter", "arguments": {"id": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_delete_outbound_webhook≈ 147 tokens
Permanently remove an outbound webhook. The external endpoint will no longer receive event notifications from this bot.
Paramètres, retour & exemple (1)
Paramètresid· string · requis
Unique identifier (UUID) of the outbound webhook to delete
Exemple d'appel{"name": "neuron_delete_outbound_webhook", "arguments": {"id": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_delete_override≈ 130 tokens
Remove a date-specific availability override, reverting to the default weekly hours.
Paramètres, retour & exemple (1)
ParamètresoverrideId· string · requis
Override UUID
Exemple d'appel{"name": "neuron_delete_override", "arguments": {"overrideId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_delete_persona≈ 107 tokens
Delete a voice persona.
Paramètres, retour & exemple (1)
Paramètresid· string · requis
Persona UUID
Exemple d'appel{"name": "neuron_delete_persona", "arguments": {"id": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_delete_product≈ 120 tokens
Permanently delete a product. Existing orders are retained.
Paramètres, retour & exemple (1)
Paramètresid· string · requis
Product UUID
Exemple d'appel{"name": "neuron_delete_product", "arguments": {"id": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_delete_sms_campaign≈ 131 tokens
Delete a draft SMS campaign. Only draft campaigns can be deleted.
Paramètres, retour & exemple (1)
ParamètrescampaignId· string · requis
UUID of the draft SMS campaign to delete
Exemple d'appel{"name": "neuron_delete_sms_campaign", "arguments": {"campaignId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_delete_social_channel≈ 142 tokens
Permanently delete a social media channel and disconnect any active sessions. This action cannot be undone.
Paramètres, retour & exemple (1)
Paramètresid· string · requis
Unique identifier (UUID) of the social channel to delete
Exemple d'appel{"name": "neuron_delete_social_channel", "arguments": {"id": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_delete_task≈ 123 tokens
Delete a scheduled task. This is a soft delete — the task stops running immediately.
Paramètres, retour & exemple (1)
Paramètresid· string · requis
UUID of the task
Exemple d'appel{"name": "neuron_delete_task", "arguments": {"id": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_delete_tool≈ 140 tokens
Permanently remove a custom API tool integration from a bot. The bot will no longer be able to invoke this tool in conversations.
Paramètres, retour & exemple (1)
Paramètresid· string · requis
Unique identifier (UUID) of the tool to delete
Exemple d'appel{"name": "neuron_delete_tool", "arguments": {"id": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_delete_webhook≈ 139 tokens
Permanently remove an inbound webhook from a bot. External services will no longer be able to trigger this endpoint.
Paramètres, retour & exemple (1)
Paramètresid· string · requis
Unique identifier (UUID) of the webhook to delete
Exemple d'appel{"name": "neuron_delete_webhook", "arguments": {"id": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_deliver_order≈ 147 tokens
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.
Paramètres, retour & exemple (1)
Paramètresid· string · requis
Order UUID
Exemple d'appel{"name": "neuron_deliver_order", "arguments": {"id": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_detach_knowledge_base≈ 167 tokens
Remove a knowledge base from a bot. The bot will no longer reference this knowledge base when generating responses.
Paramètres, retour & exemple (2)
Paramètresid· string · requis
Unique identifier (UUID) of the botkbId· string · requis
Unique identifier (UUID) of the knowledge base to detach
Exemple d'appel{"name": "neuron_detach_knowledge_base", "arguments": {"id": "texte", "kbId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_download_media≈ 230 tokens
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.
Paramètres, retour & exemple (3)
ParamètresexportId· string · optionnel
An export started earlier; returns its download link when ready.dueForRemoval· boolean · optionnel
Only media that retention removes within the next 7 days.conversationIds· array · optionnel
Only these conversations.
Exemple d'appel{"name": "neuron_download_media", "arguments": {"exportId": "texte", "dueForRemoval": true, "conversationIds": []}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_draft_task≈ 232 tokens
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.
Paramètres, retour & exemple (3)
ParamètresbotId· string · requis
UUID of the botprompt· string · requis
Plain-English description of the task, e.g. 'every morning at 8am, message 10 people we haven't heard from in 10+ days with our intro offer'.timezone· string · optionnel
IANA timezone to assume (e.g. Africa/Lagos).
Exemple d'appel{"name": "neuron_draft_task", "arguments": {"botId": "texte", "prompt": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_duplicate_product≈ 176 tokens
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.
Paramètres, retour & exemple (1)
Paramètresid· string · requis
Product UUID to clone
Exemple d'appel{"name": "neuron_duplicate_product", "arguments": {"id": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_edit_message≈ 190 tokens
Edit the content of a previously sent message in a conversation. Only the message sender can edit their messages.
Paramètres, retour & exemple (3)
Paramètresid· string · requis
Unique identifier (UUID) of the conversationmsgId· string · requis
Unique identifier (UUID) of the message to editcontent· string · requis
New text content to replace the existing message
Exemple d'appel{"name": "neuron_edit_message", "arguments": {"id": "texte", "msgId": "texte", "content": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_enroll_members≈ 521 tokens
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 }.
Paramètres, retour & exemple (6)
Paramètresid· string · requis
Product UUID (must be a membership product)silent· boolean · optionnel
Suppress the membership.started event so welcome/onboarding flows don't fire — recommended for a bulk backfill of people who are already in.members· array · optionnel
People to enroll. Omit when using fromGroup.fromGroup· boolean · optionnel
Pull every current participant of the product's attached group and enroll them all.addToGroup· boolean · optionnel
Also add each phone to the attached WhatsApp group (for people not yet in it). Default false = assume they're already in.firstPeriodDays· integer · optionnel
Free days before their first renewal. Omit to grant one normal interval (daily/weekly/monthly).
Exemple d'appel{"name": "neuron_enroll_members", "arguments": {"id": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_estimate_sms_campaign≈ 160 tokens
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.
Paramètres, retour & exemple (1)
ParamètrescampaignId· string · requis
UUID of the draft SMS campaign
Exemple d'appel{"name": "neuron_estimate_sms_campaign", "arguments": {"campaignId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_export_contacts≈ 102 tokens
Export all contacts as a downloadable dataset for the current organization.
Paramètres, retour & exemple (0)
Exemple d'appel{"name": "neuron_export_contacts", "arguments": {}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_export_flow≈ 166 tokens
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.
Paramètres, retour & exemple (1)
Paramètresid· string · requis
UUID of the flow.
Exemple d'appel{"name": "neuron_export_flow", "arguments": {"id": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_extract_leads≈ 244 tokens
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}).
Paramètres, retour & exemple (2)
Paramètrestype· string · requis · csv | text_paste | document | web_scrape | tool_output | instagram | x | facebook
Lead source type. facebook = Meta Ads Library advertisers; web/IG/X/FB scraping needs DeepAPI configured; TikTok has no native provider (use tool_output).config· object · requis
Exemple d'appel{"name": "neuron_extract_leads", "arguments": {"type": "csv", "config": {}}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_find_contact_lists_for_contact≈ 138 tokens
Retrieve all contact lists that a specific contact belongs to.
Paramètres, retour & exemple (1)
ParamètrescontactId· string · requis
Unique identifier (UUID) of the contact to look up
Exemple d'appel{"name": "neuron_find_contact_lists_for_contact", "arguments": {"contactId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_forward_message≈ 202 tokens
Forward a WhatsApp message from one chat to another. Uses copy-send approach — the message content is re-sent to the destination.
Paramètres, retour & exemple (4)
Paramètresto· string · requis
Destination chat JIDfrom· string · requis
Source chat JIDchannelId· string · requis
WhatsApp channel identifier (UUID)messageId· string · requis
WhatsApp message ID to forward
Exemple d'appel{"name": "neuron_forward_message", "arguments": {"to": "texte", "from": "texte", "channelId": "texte", "messageId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_fund_ad_request≈ 173 tokens
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.
Paramètres, retour & exemple (1)
ParamètresadRequestId· string · requis
Unique identifier (UUID) of the approved ad request to fund
Exemple d'appel{"name": "neuron_fund_ad_request", "arguments": {"adRequestId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_fund_campaign≈ 145 tokens
Fund an approved campaign by deducting the total budget from the organization's wallet balance. Requires sufficient wallet funds.
Paramètres, retour & exemple (1)
Paramètresid· string · requis
Unique identifier (UUID) of the approved campaign to fund
Exemple d'appel{"name": "neuron_fund_campaign", "arguments": {"id": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_fund_wallet≈ 185 tokens
Initialize a wallet funding transaction via Paystack. Returns a checkout URL to complete the payment in a browser.
Paramètres, retour & exemple (2)
Paramètresemail· string · requis
Email address to receive the payment receiptamount· integer · requis
Amount to fund in the smallest currency unit — kobo for NGN (e.g., 500000 = NGN 5,000)
Exemple d'appel{"name": "neuron_fund_wallet", "arguments": {"email": "texte", "amount": 1}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_generate_from_persona≈ 248 tokens
Generate content written in the persona's voice for a topic/brief. Returns N variations. Stateless — nothing is persisted.
Paramètres, retour & exemple (6)
Paramètresid· string · requis
Persona UUIDcount· integer · optionnel
Number of variations (1-10, default 1).topic· string · optionnel
What to write about.format· string · optionnel
Desired format (post, reply, caption, thread, DM...).platform· string · optionnel
Target platform (instagram/x/tiktok/linkedin/facebook/whatsapp...).extraInstructions· string · optionnel
Exemple d'appel{"name": "neuron_generate_from_persona", "arguments": {"id": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_get_ad_request≈ 140 tokens
Get detailed information about a specific ad request, including pool selections if targeting mode is manual.
Paramètres, retour & exemple (1)
ParamètresadRequestId· string · requis
Unique identifier (UUID) of the ad request
Exemple d'appel{"name": "neuron_get_ad_request", "arguments": {"adRequestId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_get_ad_request_analytics≈ 154 tokens
Retrieve delivery analytics and performance breakdown for a specific ad request, including delivery rates and cost metrics.
Paramètres, retour & exemple (1)
ParamètresadRequestId· string · requis
Unique identifier (UUID) of the ad request to get analytics for
Exemple d'appel{"name": "neuron_get_ad_request_analytics", "arguments": {"adRequestId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_get_approval≈ 206 tokens
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.
Paramètres, retour & exemple (3)
ParamètresapiKey· string · requis
Bot API key with 'nrn_' prefix for authenticationapprovalId· string · requis
The approval request id (UUID)waitSeconds· integer · optionnel
Long-poll up to N seconds for resolution
Exemple d'appel{"name": "neuron_get_approval", "arguments": {"apiKey": "texte", "approvalId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_get_availability≈ 128 tokens
Retrieve the default availability schedule (weekly hours + timezone) for a calendar.
Paramètres, retour & exemple (1)
ParamètrescalendarId· string · requis
Calendar UUID
Exemple d'appel{"name": "neuron_get_availability", "arguments": {"calendarId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_get_available_slots≈ 205 tokens
Compute available time slots for an event type over a date range, accounting for availability, existing bookings, buffers, and Google Calendar busy times.
Paramètres, retour & exemple (4)
Paramètresto· string · requis
End date (YYYY-MM-DD)from· string · requis
Start date (YYYY-MM-DD)timezone· string · optionnel
Invitee timezone for displayeventTypeId· string · requis
Event type UUID
Exemple d'appel{"name": "neuron_get_available_slots", "arguments": {"to": "texte", "from": "texte", "eventTypeId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_get_bank_account≈ 109 tokens
Retrieve the saved bank account details currently configured as the organization's payout destination.
Paramètres, retour & exemple (0)
Exemple d'appel{"name": "neuron_get_bank_account", "arguments": {}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - neuron_get_billing≈ 107 tokens
Retrieve the current billing information, subscription plan, and usage details for the organization.
Paramètres, retour & exemple (0)
Exemple d'appel{"name": "neuron_get_billing", "arguments": {}}Exemple de retour{"content": [{"type": "text", "text": "…"}]}
+ 305 autres outils (affichage limité à 120).
C'est votre serveur ?
Revendiquez-le sur l'espace créateur (preuve GitHub, domaine ou npm) pour afficher le badge « propriétaire vérifié » et lancer un pentest comportemental à la demande afin d'obtenir le badge « Vérifié ».