NeuralTalk AI API Overview

The NeuralTalk AI API allows developers to integrate our powerful conversational AI capabilities directly into their applications. This documentation provides everything you need to know to get started with our API.

Introduction

Our RESTful API enables you to:

• Create and manage AI chatbots programmatically
• Send and receive messages
• Access and update knowledge bases
• Retrieve conversation history and analytics
• Customize bot behavior and settings

Authentication

All API requests require authentication using API keys. To obtain an API key:

1. Log in to your NeuralTalk AI Dashboard
2. Navigate to Settings > API
3. Click Generate API Key
4. Copy and securely store your API key

Include your API key in the header of all requests:

Authorization: Bearer YOUR_API_KEY

Base URL

All API requests should be made to the following base URL:

https://api.neuraltalk.ai/v1

Rate Limits

Our API implements rate limiting to ensure fair usage:

Plan	Rate Limit
Free	100 requests/hour
Basic	1,000 requests/hour
Professional	10,000 requests/hour
Enterprise	Custom

When you exceed your rate limit, the API will return a 429 Too Many Requests response.

Response Format

All API responses are returned in JSON format. A typical successful response includes:

{
  "status": "success",
  "data": {
    // Response data
  }
}

Error responses follow this format:

{
  "status": "error",
  "error": {
    "code": "error_code",
    "message": "Description of the error"
  }
}

Available Endpoints

Chatbots

Endpoint	Method	Description
/chatbots	GET	List all chatbots
/chatbots/{id}	GET	Get a specific chatbot
/chatbots	POST	Create a new chatbot
/chatbots/{id}	PUT	Update a chatbot
/chatbots/{id}	DELETE	Delete a chatbot

Conversations

Endpoint	Method	Description
/conversations	GET	List conversations
/conversations/{id}	GET	Get a specific conversation
/conversations	POST	Start a new conversation
/conversations/{id}/messages	POST	Send a message

Knowledge Base

Endpoint	Method	Description
/knowledge	GET	List knowledge items
/knowledge/{id}	GET	Get a specific knowledge item
/knowledge	POST	Add knowledge
/knowledge/{id}	PUT	Update knowledge
/knowledge/{id}	DELETE	Delete knowledge

Analytics

Endpoint	Method	Description
/analytics/usage	GET	Get usage statistics
/analytics/conversations	GET	Get conversation metrics
/analytics/performance	GET	Get performance metrics

Example: Sending a Message

Here's an example of sending a message using the API:

curl -X POST "https://api.neuraltalk.ai/v1/conversations/conv_123/messages" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "text": "What are your business hours?",
    "user_id": "user_456"
  }'

SDKs and Libraries

We provide official client libraries for several programming languages:

• JavaScript/Node.js
• Python
• PHP
• Ruby
• Java

Webhooks

Our API supports webhooks for real-time notifications of events. Configure webhooks in the dashboard or via the API to receive notifications for:

• New messages
• Conversation started
• Conversation ended
• Knowledge base updated
• Error events

Versioning

The API is versioned with the version number included in the URL path. The current version is v1. We provide backward compatibility for at least 12 months after a new version is released.

Support

If you need help with our API, you can:

• Visit our API Documentation
• Join our Developer Community
• Email our Developer Support Team

Get Started with the API

Ready to integrate NeuralTalk AI into your application? Check out our API Quickstart Guide to send your first API request in minutes.