# Neuron Bot API

**Canonical:** https://apis.io/apis/neuron-ng/neuron-ng-bot-api-api/  
**Provider:** Neuron — https://apis.io/providers/neuron-ng/  
**Base URL:** https://api.neuron.ng/api/v1  
**Documentation:** https://neuron.ng/docs

Neuron Bot API is one of 25 APIs that [Neuron](https://apis.io/providers/neuron-ng/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 2 JSON Schema definitions. Tagged areas include Bot API. The published artifact set on APIs.io includes an OpenAPI specification and 2 JSON Schemas.

External integration API (API key auth)

## Operations (38)

| Method | Path | Summary |
|---|---|---|
| POST | `/bot-api/chat` | Send message and get AI response |
| POST | `/bot-api/send` | Queue WhatsApp message |
| GET | `/bot-api/conversations` | List conversations |
| GET | `/bot-api/conversations/{conversationId}/messages` | Get messages in conversation |
| GET | `/bot-api/bot` | Get bot details |
| POST | `/bot-api/compose` | Compose outbound message |
| POST | `/bot-api/conversations/{conversationId}/send` | Send message in conversation |
| POST | `/bot-api/media/upload` | Upload media file |
| POST | `/bot-api/ai/rewrite` | AI rewrite message |
| GET | `/bot-api/contacts` | List contacts |
| POST | `/bot-api/contacts` | Create contact |
| GET | `/bot-api/contacts/search` | Search contacts (autocomplete) |
| GET | `/bot-api/contacts/export` | Export contacts as CSV |
| POST | `/bot-api/contacts/import` | Import contacts from CSV data |
| PUT | `/bot-api/contacts/{id}` | Update contact |
| DELETE | `/bot-api/contacts/{id}` | Delete contact |
| GET | `/bot-api/broadcasts` | List broadcasts |
| POST | `/bot-api/broadcasts` | Create broadcast |
| GET | `/bot-api/broadcasts/{id}` | Get broadcast with recipients |
| PUT | `/bot-api/broadcasts/{id}` | Update draft broadcast |
| DELETE | `/bot-api/broadcasts/{id}` | Delete draft broadcast |
| POST | `/bot-api/broadcasts/{id}/send` | Start sending broadcast |
| GET | `/bot-api/broadcasts/{id}/recipients` | List broadcast recipients |
| POST | `/bot-api/status` | Post a WhatsApp Status / Story |
| POST | `/bot-api/leads/ingest` | Ingest a single lead (deduped) |
| POST | `/bot-api/leads/ingest/bulk` | Ingest up to 500 leads (deduped). Fires the source's triggerTaskId on new leads |
| GET | `/bot-api/tasks` | List this bot's tasks |
| POST | `/bot-api/tasks` | Create a task for this bot |
| PUT | `/bot-api/tasks/{id}` | Update this bot's task |
| DELETE | `/bot-api/tasks/{id}` | Delete this bot's task |
| POST | `/bot-api/tasks/{id}/toggle` | Pause/resume this bot's task |
| POST | `/bot-api/tasks/{id}/run` | Run this bot's task now |
| GET | `/bot-api/tasks/{id}/runs` | Get this bot's task run history |
| GET | `/bot-api/personas` | List voice personas |
| POST | `/bot-api/personas/build` | Distill a voice from a Collection |
| GET | `/bot-api/personas/{id}` | Get a persona |
| POST | `/bot-api/personas/{id}/generate` | Generate content in the persona's voice |
| POST | `/bot-api/personas/{id}/apply` | Give the calling bot this persona's voice (idempotent) |

## Machine-readable artifacts (3)

- **OpenAPI** — https://artifacts.apis.io/neuron-ng/openapi/neuron-ng-bot-api-api-openapi.yml
- **JSONSchema** — https://artifacts.apis.io/neuron-ng/json-schema/neuron-ng-persona-schema.json
- **JSONSchema** — https://artifacts.apis.io/neuron-ng/json-schema/neuron-ng-bot-task-schema.json

## Other Neuron APIs (12)

- [Neuron Account API](https://apis.io/apis/neuron-ng/neuron-ng-account-api-api/)
- [Neuron Approvals API](https://apis.io/apis/neuron-ng/neuron-ng-approvals-api/)
- [Neuron Audit API](https://apis.io/apis/neuron-ng/neuron-ng-audit-api/)
- [Neuron Auth API](https://apis.io/apis/neuron-ng/neuron-ng-auth-api/)
- [Neuron Billing API](https://apis.io/apis/neuron-ng/neuron-ng-billing-api/)
- [Neuron Blog API](https://apis.io/apis/neuron-ng/neuron-ng-blog-api/)
- [Neuron Bot Setup API](https://apis.io/apis/neuron-ng/neuron-ng-bot-setup-api/)
- [Neuron Bots API](https://apis.io/apis/neuron-ng/neuron-ng-bots-api/)
- [Neuron Builtin Tools API](https://apis.io/apis/neuron-ng/neuron-ng-builtin-tools-api/)
- [Neuron Channels API](https://apis.io/apis/neuron-ng/neuron-ng-channels-api/)
- [Neuron Conversations API](https://apis.io/apis/neuron-ng/neuron-ng-conversations-api/)
- [Neuron Health API](https://apis.io/apis/neuron-ng/neuron-ng-health-api/)

## Tags

Bot API

## Use this from code or an agent

- **REST, no key:** `GET https://apis.io/api/v1/providers/neuron-ng` returns the provider's full profile as JSON.
- **MCP:** `https://apis.io/mcp` (Streamable HTTP) — search the catalog, read any provider, compare providers, check agent readiness.
- **Free API key** for catalog-wide search, ratings and comparisons: sign in with GitHub, Google or LinkedIn at https://apis.io/developer/account/ (plans: https://apis.io/developer/plans/).

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/neuron-ng/neuron-ng-bot-api-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/neuron-ng/.
