Getting Started
Developer Overview
Welcome to the Docimal Developer Guide! Whether you're embedding a simple chat widget or building complex integrations, this guide will help you implement AI-powered conversations in your application.
DocimalChoose Your Integration Path
JavaScript Embed Script
Perfect for web developers who want to add a chat widget with custom behavior, event handling, and rich user experiences.
REST API Integration
Ideal for backend developers building custom chat interfaces, mobile apps, or server-to-server integrations.
API v2
The latest API with structured errors, streaming via SSE, and cursor-based pagination.
JavaScript Embed Integration
Perfect for web developers who want rich chat functionality with minimal complexity. The JavaScript embed script provides:
- Simple Integration: Add to any website with one script tag.
- Advanced Features: Event listeners, custom actions, and custom initial message.
- Identity Verification: Secure user sessions for authenticated apps and contact management.
- Real-time Events: React to user messages and AI responses.
Complete JavaScript Embed Guide
Get the full implementation guide with examples, advanced features, and best practices
REST API Integration
Ideal for backend developers who need complete control over AI conversations. The REST API provides:
- Chat API: Send messages and receive AI responses with streaming support
- Agent Management: Create, update, and configure AI agents programmatically
- Data Access: Retrieve conversations, leads, and analytics
- Webhooks: Real-time notifications for chat events
Complete REST API Guide
Get the full API documentation with examples, authentication, and best practices