Developer Guide

Build powerful integrations with NeuraIntell API

Quick Start

1. Get Your API Key

Generate an API key from your dashboard to authenticate requests.

// Include your API key in request headers
headers: {
  'Authorization': 'Bearer YOUR_API_KEY',
  'Content-Type': 'application/json'
}

2. Embed Chat Widget

Add this code snippet to your website to embed the chat widget:

<!-- Add before closing </body> tag -->
<script src="https://yourapp.com/widget.js"></script>
<script>
  NeuraIntell.init({
    apiKey: 'YOUR_API_KEY',
    position: 'bottom-right',
    theme: 'dark'
  });
</script>

REST API Endpoints

Base URL: https://api.neuraintell.com/v1

POST
/api/auth/signup

Create new user account

POST
/api/auth/login

Authenticate user

POST
/api/auth/verify

Verify email code

POST
/api/documents/upload

Upload knowledge base documents

POST
/api/documents/url

Crawl URL for content

GET
/api/documents

List all documents

DELETE
/api/documents/:id

Delete document

POST
/api/chat

Send chat message to AI

GET
/api/chat/history

Get conversation history

POST
/api/api-keys/generate

Generate new API key

GET
/api/api-keys

List API keys

DELETE
/api/api-keys/:id

Revoke API key

GET
/api/analytics/conversations

Get conversation metrics

POST
/api/integrations/:provider/oauth

Initialize OAuth flow

GET
/api/integrations/:provider/callback

Handle OAuth callback

Webhook Configuration

Configure webhooks to receive real-time notifications for events:

  • New conversation started
  • Message sent or received
  • Low confidence response triggered
  • Document upload completed
// Webhook payload example
{
  "event": "message.received",
  "timestamp": "2025-01-15T10:30:00Z",
  "data": {
    "conversationId": "conv_123",
    "message": "How do I reset my password?",
    "confidence": 0.95,
    "sources": ["doc_456", "doc_789"]
  }
}

SDKs & Libraries

JavaScript/TypeScript

NPM package for Node.js and browser

npm install @neuraintell/sdk

Python

PyPI package for Python applications

pip install neuraintell

REST API

Use with any programming language

curl api.neuraintell.com

Need Help Building?

Join our developer community or contact our technical support team.