Chat Data API Schema Guide (2.0.0)

Create a Chatbot using either our medical chat models, custom data upload, or a custom model. The default model is custom-data-upload if not specified.

Available models:

• custom-data-upload: For training with your own data using GPT-4o-mini, GPT-4o or GPT-4.0, Claude 3 Opus, Claude 3.5 Sonnet, Claude 3 Haiku
• medical-chat-human: For medical chat with humans
• medical-chat-vet: For medical chat with veterinarians
• custom-model: For using a custom model

For custom-data-upload model, you can provide training data using sourceText or urlsToScrape. These fields are ignored for other models.

You can also specify a custom backend URL and bearer token if you prefer to use your own backend.

You can poll the status of the training by GET /chatbot/status/{chatbotId} at interval of 10s. Generally it takes 1-2 minutes to finish depending on content length of the provided text or websites.

Example request by curl:

curl -X POST https://api.chat-data.com/api/v2/create-chatbot \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{
  "chatbotName": "My Chatbot",
  "sourceText": "Training text for the chatbot",
  "urlsToScrape": [
    "https://www.chat-data.com/api-reference",
    "https://www.chat-data.com/privacy"
  ],
  "model": "custom-data-upload"
}'

Note: The sourceText and urlsToScrape fields are subject to character limits based on your plan.

The Chatbot Retrain API enables you to retrain an existing chatbot. This API is applicable for chatbots with the custom-data-upload model. It allows you to update the chatbot's knowledge base with new information or remove existing data.

You can provide new training data through various methods:

• Text data via sourceText
• URLs to scrape via urlsToScrape
• Product information via products
• Q&A pairs via qAndAs

You can also remove specific knowledge chunks using the deletes array.

Example request by curl:

curl -X POST https://api.chat-data.com/api/v2/retrain-chatbot \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{
  "chatbotId": "your_chatbot_id",
  "sourceText": "New training data for the chatbot",
  "urlsToScrape": ["https://www.example.com/new-content"],
  "products": [
    {
      "id": "product_123",
      "information": {
        "name": "New Product",
        "description": "Product description"
      }
    }
  ],
  "qAndAs": [
    {
      "question": "What is the new feature?",
      "answer": "The new feature is..."
    }
  ],
  "deletes": [
    {
      "type": "website",
      "url": "https://www.example.com/old-content"
    }
  ],
  "options": {
    "Cookies": "",
    "extractMainContent": true,
    "includeOnlyTags": "",
    "excludeTags": ""
  }
}'

Note: The amount of new data you can add is subject to character limits based on your plan.

Get the current training progress of the chatbot.

Example request by curl:

curl -X GET https://api.chat-data.com/api/v2/chatbot/status/{chatbotId} \
-H "Authorization: Bearer YOUR_API_KEY"

This API enables the deletion of a chatbot by specifying its ID. It removes the chatbot along with its associated data from the system, including training data, user monitoring data, conversations, leads information, etc. Exercise caution when using this deletion action, as all deleted sources are unrecoverable.

Example request by curl:

curl -X DELETE https://api.chat-data.com/api/v2/delete-chatbot/{chatbotId} \
-H "Authorization: Bearer YOUR_API_KEY"

Returns a list of all chatbots under your account with related information.

Example request by curl:

curl -X GET https://api.chat-data.com/api/v2/get-chatbots \
-H "Authorization: Bearer YOUR_API_KEY"

Returns the related information about a single chatbot. The returned chatbot schema is the same as the /get-chatbotsendpoint.

Example request by curl:

curl -X GET https://api.chat-data.com/api/v2/get-chatbot/{chatbotId} \
-H "Authorization: Bearer YOUR_API_KEY"

This API endpoint allows you to edit your chatbot.

Example request by curl:

curl -X POST https://api.chat-data.com/api/v2/update-chatbot-settings \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{
  "chatbotId": "your_chatbot_id",
  "chatbotName": "Updated Chatbot Name",
  "basePrompt": "You are a helpful assistant specialized in customer support",
  "initialMessages": ["Welcome! How can I assist you today?"],
  "visibility": "private"
}'

Add a webhook endpoint with the corresponding event type([chat, live-chat-escalation, 'lead-submission']) for the chatbot to send real-time events.

Example request by curl:

curl -X POST https://api.chat-data.com/api/v2/add-webhook \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{
  "chatbotId": "your_chatbot_id",
  "url": "https://your-webhook-endpoint.com",
  "event": "chat"
}'

Delete the webhook which has the give url and all event under the webhook.

Example request by curl:

curl -X POST https://api.chat-data.com/api/v2/delete-webhook \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{
  "chatbotId": "your_chatbot_id",
  "url": "https://your-webhook-endpoint.com"
}'

This API endpoint allows you to update the profile picture of your chatbot.

Example request by curl:

curl -X POST -H "Content-Type: multipart/form-data" -F "image=@/path/to/your/image.jpg" https://api.chat-data.com/api/v2/upload-chatbot-profile-picture/{chatbotId}

Delete a chatbot profile picture.

Example request by curl:

curl -X DELETE https://api.chat-data.com/api/v2/delete-chatbot-profile-picture/{chatbotId} \
-H "Authorization: Bearer YOUR_API_KEY"

This API endpoint allows you to update the icon picture of your chatbot.

Example request by curl:

curl -X POST -H "Content-Type: multipart/form-data" -F "image=@/path/to/your/image.jpg" https://api.chat-data.com/api/v2/upload-chatbot-icon/{chatbotId}

Delete a chatbot icon picture.

Example request by curl:

curl -X DELETE https://api.chat-data.com/api/v2/delete-chatbot-icon/{chatbotId} \
-H "Authorization: Bearer YOUR_API_KEY"

This operation retrieves the confidence scores (defined as cosine similarity) of related chunks used to generate answers. You can use this function to obtain confidence scores before calling the /chat API endpoint, providing an estimate of the chatbot's ability to deliver high-quality answers based on the context. Chunks are cached based on the messages array, so subsequent calls to the /chat API with the same messages array will incur minimal latency in retrieving related vector embeddings from the database. Therefore, calling this API endpoint before /chat should not significantly impact overall chat performance.

Example request by curl:

curl -X POST https://api.chat-data.com/api/v2/get-confidence-score \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{
  "messages": [
    {"role": "user", "content": "What are your services?"}
  ],
  "chatbotId": "your_chatbot_id"
}'

This operation fetches segments pertinent to generating responses. Designed for seamless chatbot integration with the GPTs store, this API endpoint allows users to supply relevant document fragments to the GPTs. Similar to the /get-confidence-score endpoint, this API are cached for efficiency based on the query.

Example request by curl:

curl -X POST https://api.chat-data.com/api/v2/query-knowledge-base/{chatbotId} \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{
  "query": "What services do you offer?",
  "count": 5
}'

Send messages to a chatbot and receive a response.

Example request by curl:

curl -X POST https://api.chat-data.com/api/v2/chat \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{
  "messages": [
    {"role": "user", "content": "Hello, how can you help me?"}
  ],
  "chatbotId": "your_chatbot_id",
  "stream": false
}'

Deletes a specific conversation associated with a chatbot. This operation requires both the chatbotId and conversationId.

Example request by curl:

curl -X DELETE https://api.chat-data.com/api/v2/delete-conversation \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{
  "chatbotId": "your_chatbot_id",
  "conversationId": "conversation_id_to_delete"
}'

Send live chat messages to a chatbot for an existing conversation.

Example request by curl:

curl -X POST https://api.chat-data.com/api/v2/live-chat \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{
  "chatbotId": "your_chatbot_id",
  "conversationId": "your_conversation_id",
  "message": "Hello, this is a live chat message.",
  "name": "John Doe",
  "avatar": "https://example.com/avatar.jpg",
  "files": [
    {
      "name": "document.pdf",
      "type": "application/pdf",
      "url": "https://example.com/document.pdf"
    }
  ]
}'

Toggle the state of a live chat session for a specific conversation. Example request by curl:

curl -X POST https://api.chat-data.com/api/v2/livechat-state \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{
  "chatbotId": "your_chatbot_id",
  "conversationId": "your_conversation_id",
  "end": true
}'

Upload a file to be used with a chatbot.

Example request by curl:

curl -X POST -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: multipart/form-data" -F "file=@/path/to/your/file" https://api.chat-data.com/api/v2/upload-file/{chatbotId}

This API endpoint allows you to delete a previously uploaded file associated with a chatbot.

Example request by curl:

curl -X POST https://api.chat-data.com/api/v2/delete-file \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{
  "chatbotId": "{chatbotId}",
  "fileUrl": "https://storage.azure.com/your-container/chatbot_id/filename.pdf"
}'

Generate a 30-day Shared Access Signature (SAS) token for accessing a specific file

Get conversations from a chatbot. This operation support paginations. Example request by curl:

curl -X GET https://api.chat-data.com/api/v2/get-conversations/{chatbotId}?startTimestamp={value1}&endTimestamp={value2}&start={value3}&size={value4}&source={value5}

Get detailed information about a specific conversation, including messages, customer details if available, and metadata.

Example request by curl:

curl -X GET https://api.chat-data.com/api/v2/get-conversation/{conversationId} \
-H "Authorization: Bearer YOUR_API_KEY"

Get collected customers from a chatbot. This operation support paginations. Example request by curl:

curl -X GET https://api.chat-data.com/api/v2/get-customers/{chatbotId}?startTimestamp={value1}&endTimestamp={value2}&start={value3}&size={value4}&source={value5}

Get the aggregated statistics of a chatbot. Example request by curl:

curl -X GET https://api.chat-data.com/api/v2/get-analysis/{chatbotId}?startTimestamp={value1}&endTimestamp={value2}