AI Agent Management
Deploy Your Agent
Deploy your Docimal agent across web, mobile, and third-party platforms with chat widgets, iFrame embeds, REST API, and integrations.
Overview
The Deploy section lets you make your Docimal agent available to users across multiple channels, including your website, mobile apps, and third-party platforms. You can enable one or multiple deployment channels depending on how you want users to interact with your agent.
Chat Widget
Add a floating chat bubble to your website with full customization
iFrame Embed
Embed the chat interface directly as an iframe on any page
REST API
Integrate your agent programmatically via REST API
Integrations
Connect with Slack, Email, Zapier, and other platforms
Chat Widget
The Chat Widget is a floating chat bubble that appears on your website, allowing visitors to interact with your AI agent in real-time. It's fully customizable and supports all advanced features of Docimal.
Enable the Chat Widget
- 1Open your workspace and go to the Chatbot page
- 2Configure your agent in the Settings, Appearance, and Features tabs
- 3Publish your chatbot to make the configuration live
- 4Go to the Deploy tab — create an API key and copy the embed code
- 5Paste the script into your website's HTML before the closing
</body>tag
Content Settings
In the chatbot Appearance settings, you can control what users see:
- Display Name — The name shown at the top of the chat widget header
- Avatar — Profile image displayed in the widget header and messages
- Welcome Message — The first message users see when opening the chat
- Suggested Questions — Predefined prompts to help users start conversations quickly
- Message Feedback — Enable thumbs up/down buttons for user feedback on responses
- Show Sources — Display document sources that the AI used to generate responses
- Typing Indicator — Show a typing animation while the AI is generating a response
- Notification Sound — Play a sound when new messages arrive
- Powered by Branding — Toggle the "Powered by Docimal" footer
Style Settings
The Appearance tab in Chatbot settings lets you customize the visual appearance to match your brand:
Colors & Theme
- • Light or Dark mode
- • Primary color (accents & user messages)
- • Header style (light or colored)
- • Message style (plain or colored)
Typography & Shape
- • Font family
- • Border radius
- • Input style (default, rounded, inside)
- • Agent avatar image
Position & Layout
- • Bottom-right or bottom-left
- • Inline mode (embed in container)
- • Start open or closed
- • Mobile responsive
Behavior
- • Auto-open on first visit
- • Show on all pages toggle
- • Session persistence
- • Powered by branding toggle
Security & Domain Restrictions
Embed Code — Script Tag (Recommended)
<script
src="https://cdn.docimal.site/latest/docimal-chatbot.js"
data-api-key="YOUR_API_KEY"
data-base-url="https://api.docimal.site/agents"
async
></script>dcml_pk_). Generate one from the Deploy tab in your chatbot settings.iFrame Embed
The iFrame embed allows you to integrate the full chat interface directly into your page as an embedded frame. This is useful when you want the chat to be part of your page layout rather than a floating widget.
When to Use iFrame
iFrame Code Example
<iframe
src="https://cdn.docimal.site/embed.html?key=YOUR_API_KEY"
width="400"
height="600"
style="border: none; border-radius: 12px;"
></iframe>dcml_pk_...). The iframe renders the full chat interface without the floating bubble.REST API Integration
For developers who need full programmatic control, the Docimal REST API allows you to integrate your agent into custom applications, mobile apps, backend systems, or any platform that can make HTTP requests.
API Features
✓ Complete Control
Build custom UIs and integrate into any platform or application
✓ Conversation Management
Create, retrieve, and manage conversation threads programmatically
✓ Streaming Responses
Real-time streaming for faster, more responsive user experiences
✓ Authentication
Secure API key authentication with workspace-level access control
Getting Your API Key
- 1Open your workspace and go to the Chatbot page
- 2Navigate to the Deploy tab
- 3In Step 1, click Create API Key — set a name, allowed domains, and rate limits
- 4Copy and securely store your key (prefixed with
dcml_pk_— it won't be shown again)
Basic API Example
// Step 1: Start a chat session
const session = await fetch('https://api.docimal.site/agents/api/v1/public/chatbot/sessions', {
method: 'POST',
headers: {
'X-API-Key': 'dcml_pk_YOUR_API_KEY',
'Content-Type': 'application/json'
},
body: JSON.stringify({
metadata: { pageUrl: window.location.href }
})
});
const { sessionId } = await session.json();
// Step 2: Send a message
const response = await fetch(
`https://api.docimal.site/agents/api/v1/public/chatbot/sessions/${sessionId}/messages`,
{
method: 'POST',
headers: {
'X-API-Key': 'dcml_pk_YOUR_API_KEY',
'Content-Type': 'application/json'
},
body: JSON.stringify({
message: 'What are your pricing plans?'
})
}
);
const data = await response.json();
console.log(data.assistantMessage);Third-Party Integrations
Docimal integrates with popular platforms to meet your users where they already are. Connect your agent to messaging apps, productivity tools, and customer support platforms.
Slack
Connect your agent to Slack so team members can ask questions directly in channels or via DM.
Ideal for internal knowledge bases and team support
Email (Beta)
Let your agent respond automatically to incoming email inquiries at a dedicated support address.
Perfect for customer support and inbound inquiries
Zapier
Use Zapier to connect your agent with thousands of apps and automate complex workflows.
Connect to CRMs, spreadsheets, and automation tools
WordPress
Use the official Docimal WordPress plugin to add the chat widget without writing code.
Easy one-click installation for WordPress sites
Best Practices
Start with One Channel
Begin with a single deployment channel (usually the Chat Widget) and ensure it works perfectly before expanding to other channels. This allows you to refine your agent's responses and configuration in a controlled environment.
Test Before Deploying
Always test your agent thoroughly in the Playground before making it live. Verify that responses are accurate, citations are working, and the user experience is smooth. Use the domain restriction feature to test on staging environments first.
Customize Per Channel
Different channels serve different audiences. Customize your agent's greeting, suggested messages, and behavior for each channel. For example, Slack messages can be more casual while email responses should be more formal.
Monitor Performance
Use the Analytics section to track how users interact with your agent across different deployment channels. Monitor response accuracy, conversation completion rates, and user satisfaction to continuously improve.
Secure Your API Keys
If using REST API integration, never expose API keys in client-side code. Always make API calls from your backend server. Rotate keys regularly and immediately revoke any keys that may have been compromised.
Use Domain Restrictions
Enable domain restrictions to prevent unauthorized use of your agent. This is especially important if your agent has access to sensitive information or uses paid API credits.