moinAI Technical Documentation moinAI Technical Documentation
Home
moinAI website (opens new window)
moinAI Hub (opens new window)
Home
moinAI website (opens new window)
moinAI Hub (opens new window)
  • Widget Integration
  • Widget JS API
  • REST API Reference
    • MoinAI API: REST based interaction with your chatbot and its Knowledge Base
      • Introducing MoinAI's Flexible API Solution
      • External Knowledge API
      • Knowledge Base Search API
      • Channel API (Coming soon)
    • External Knowledge API
      • Overview
      • Authentication
      • Endpoints
        • 1. Create a New Article
        • 2. Retrieve Articles
        • 3. Update an Article
        • 4. Delete an Article
        • 5. Get Agents
    • Knowledge Base Search API
      • Overview
      • Authentication
      • Endpoint: Search for knowledge that is related to a query
        • Request Body
        • Response
        • Example Usage
    • Channel API (Coming soon)
      • Overview
      • Getting Started
        • Prerequisites
        • Base URL
      • Authentication
        • Example Request
      • API Endpoints
        • Create Conversation
        • Send Message
        • Get Conversation
        • Get Message History
        • Update Context
        • End Conversation
      • Conversation Language
        • The value
      • Webhooks
        • Webhook Configuration
        • Webhook Payload
        • AI-generated messages
        • Auto-translated messages
        • What the answer was based on
        • The Bot Asks for a File
        • Signature Verification
      • Message Components
        • Text
        • Image / Video
        • File
        • Quick Replies
        • Buttons
        • Carousel
      • Rate Limits
      • Error Handling
        • Error Response Format
        • Error Codes
      • Best Practices
        • 1. Understand conversationId vs userId
        • 2. Implement Robust Webhook Handling
        • 3. Verify Webhook Signatures
        • 4. Handle Quick Replies
        • 5. Handle Connection Issues
        • 6. Use Context Effectively
      • SDK Examples
        • Node.js
        • Python
      • Live Agent Handover
        • Working in your own agent client
        • Overview
        • Handover States
        • Handover Flow
        • Handover Endpoints
        • User Messages During Handover
        • Typing Indicators
        • Queue Management
        • Handover Webhook Payloads
        • Comprehensive Handover Integration Example
        • Handover Integration Example (Simple)
        • Handover Best Practices
        • Handover SDK Extensions
      • Support
  • Context, Templates & Webhooks

# moinAI API Reference

  • API Reference
    • External Knowledge API
    • Knowledge Base Search API
    • Channel API (Coming soon)