Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.aihive.global/llms.txt

Use this file to discover all available pages before exploring further.

​
Developer Documentation (Developers & API)

AIHive provides a powerful toolkit (API & SDK) to help you integrate artificial intelligence into your website, mobile app, or internal management system (ERP/CRM) quickly.

​
Chat Widget Integration (Web SDK)

This is an “instant” solution (No-code) that allows you to add AIHive to your website with just a simple HTML code snippet. First, go to the “AI Setup” interface, after completing the setup. Click “Publish” image.png

​
Method 1: Floating Chat Bubble

Displays a chat icon in the corner of the screen. Suitable for Landing Pages or homepages. Copy the following code and paste it into the <body> or <footer> tag of your website: 
<script>
 window.difyChatbotConfig = \{
  token: 'YOUR_TOKEN_HERE', // Replace with the Token from the Agent configuration page
  baseUrl: '[<
https://api.aihive.global>](<https://api.aihive.global
>)'
 \}
</script>
<script
 src="[<
https://api.aihive.global/embed.min.js>](<https://api.aihive.global/embed.min.js
>)"
 id="YOUR_TOKEN_HERE"
 defer>
</script>

​
Method 2: Full Page Embed

Transform a sub-page into a dedicated AI chat interface (similar to ChatGPT interface). Paste the following code into the <body> tag: 
<style>
 /* Hide button, force chat frame to full screen */
 #dify-chatbot-bubble-button \{
  display: none;
 \}
 #dify-chatbot-bubble-window \{
  width: 100% !important;
  height: 100% !important;
  bottom: 0 !important;
  right: 0 !important;
 \}
</style>

<script>
 window.difyChatbotConfig = \{
  token: 'YOUR_TOKEN_HERE',
  baseUrl: '[<
https://api.aihive.global>](<https://api.aihive.global
>)'
 \}
</script>
<script
 src="[<
https://api.aihive.global/embed.min.js>](<https://api.aihive.global/embed.min.js
>)"
 id="YOUR_TOKEN_HERE"
 defer>
</script>

​
Method 3: iFrame Embed (Fixed Chat Frame)

Embed a chat frame in a fixed position within an article or admin dashboard interface. 
<iframe
 src="[<https://app.aihive.global/chatbot/YOUR_TOKEN_HERE>](<https://app.aihive.global/chatbot/YOUR_TOKEN_HERE>)"
 style="width: 100%; height: 600px; border: none; border-radius: 10px;">
</iframe>

​
Chat API (Backend Integration)

Use this API to build a custom chat interface (Custom UI) on Mobile App or send/receive messages from your Server.

​
1. Connection Information

  • Base URL: https://api.aihive.global/v1
  • Endpoint: /chat-messages
  • Method: POST

​
2. Authentication

Go to the Agent setup interface, click “Publish” and copy the API Key here image.png

​
2. Authentication

All requests must include an authentication Header for security: 
Authorization: Bearer app-xxxxxxxxxxxxxxxxxxxxxxxx
Content-Type: application/json

​
3. Body Parameters (Data to Send)

ParameterData TypeRequiredDescription
inputsObject✅Input variables (e.g., name, age). Leave empty \{\} if not used.
queryString✅User’s message content (e.g., “Hello”).
response_modeString✅blocking: Wait and return result at once (Recommended).
streaming: Return word by word (typing effect).
conversation_idString❌Conversation ID. Leave empty "" for the first message. Send the old ID for subsequent messages so the Bot remembers context.
userString✅Unique user identifier (e.g., user-123).

​
4. Request Example (cURL)

You can quickly test the connection using Terminal: 
curl -X POST '[<
https://api.aihive.global/v1/chat-messages>](<https://api.aihive.global/v1/chat-messages
>)' \\
--header 'Authorization: Bearer app-xxxxxxxxxxxxxxxxxxxxxxxx' \\
--header 'Content-Type: application/json' \\
--data-raw '\{
    "inputs": \{\},
    "query": "Advise me about products",
    "response_mode": "blocking",
    "conversation_id": "",
    "user": "customer-01"
\}'

​
5. Response Example (Returned Result)

If the call is successful, the Server will return JSON containing the AI’s answer: 
\{
    "event": "message",
    "message_id": "99f074xx-xxxx-xxxx",
    "conversation_id": "88e912xx-xxxx-xxxx",
    "mode": "chat",
    "answer": "Hello, how can AIHive help you today?",
    "metadata": \{
        "usage": \{
            "prompt_tokens": 50,
            "completion_tokens": 20,
            "total_tokens": 70
        \}
    \},
    "created_at": 1705634000
\}

​
Error Handling

Error Code (HTTP Code)CauseSolution
401 UnauthorizedWrong API Key.Check the Authorization Header to see if the key is correct.
402 Payment RequiredPlan quota expired.Top up or upgrade your AIHive plan.
404 Not FoundWrong API path.Check if the Base URL is correct: https://api.aihive.global.
429 Too Many RequestsSending too fast (Spam).Limit message sending rate or contact to upgrade your limit.