API Documentation

{
  "name": "My Integration Key",
  "expiresAt": "2026-12-31T23:59:59Z",
  "chatbotId": "507f1f77bcf86cd799439011"
}

{
  "success": true,
  "message": "API key generated successfully...",
  "data": {
    "id": "507f1f77bcf86cd799439011",
    "key": "sk_live_abcd1234efgh5678ijkl9012mnop3456qrst7890uvwx",
    "keyPrefix": "sk_live_abcd1234efgh5678...",
    "name": "My Integration Key",
    "expiresAt": "2026-12-31T23:59:59.000Z",
    "createdAt": "2025-11-10T12:00:00.000Z"
  }
}

{
  "success": true,
  "data": {
    "chatbot": {
      "id": "507f1f77bcf86cd799439011",
      "name": "Customer Support Bot",
      "isPublic": true,
      "appearance": {
        "title": "Support Assistant",
        "welcomeMessage": "Hello! How can I help you today?",
        "placeholderText": "Type your question...",
        "suggestions": [
          { "value": "What are your hours?" }
        ],
        "enableDocumentUpload": true,
        "showCitations": true
      },
      "createdAt": "2025-01-15T10:00:00.000Z"
    }
  }
}

{
  "metadata": {
    "source": "mobile-app",
    "clientId": "user-12345"
  }
}

{
  "success": true,
  "data": {
    "conversation": {
      "id": "507f1f77bcf86cd799439011",
      "chatbotId": "507f1f77bcf86cd799439012",
      "chatbot": {
        "id": "507f1f77bcf86cd799439012",
        "name": "Customer Support Bot"
      },
      "createdAt": "2025-11-10T10:00:00.000Z"
    }
  }
}

{
  "message": "What are your business hours?",
  "documentIds": ["507f1f77bcf86cd799439015"]
}

{
  "success": true,
  "data": {
    "userMessage": {
      "id": "507f1f77bcf86cd799439016",
      "content": "What are your business hours?",
      "isFromUser": true,
      "createdAt": "2025-11-10T10:16:00.000Z"
    },
    "botResponse": {
      "id": "507f1f77bcf86cd799439017",
      "content": "Our business hours are Monday through Friday, 9:00 AM to 5:00 PM EST.",
      "isFromUser": false,
      "createdAt": "2025-11-10T10:16:03.000Z",
      "citations": [
        {
          "title": "Contact Information",
          "url": "https://example.com/contact",
          "snippet": "Hours of operation: Mon-Fri 9AM-5PM EST"
        }
      ]
    }
  }
}

[START:507f1f77bcf86cd799439016]
Our return policy allows you to return most items within 30 days of purchase.

1. Items must be in original condition
2. You'll need the original receipt

[COMPLETE]
{"botMessageId":"507f1f77bcf86cd799439017","citations":[...]}

data: {"type":"start","userMessageId":"507f1f77bcf86cd799439016"}

data: {"type":"content","content":"Our return policy"}

data: {"type":"content","content":" allows you to return"}

data: {"type":"complete","botMessageId":"507f1f77bcf86cd799439017","citations":[]}

{
  "success": true,
  "data": { ... }
}

{
  "success": false,
  "error": {
    "code": "ERROR_CODE",
    "message": "Human-readable error description"
  }
}

curl -X GET "https://api.chat.co/client/v1/chatbot" \
  -H "Authorization: Bearer sk_live_your_api_key"

curl -X POST "https://api.chat.co/client/v1/conversations" \
  -H "Authorization: Bearer sk_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{}'

curl -X POST "https://api.chat.co/client/v1/conversations/CONVERSATION_ID/messages" \
  -H "Authorization: Bearer sk_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"message": "Hello, I need help"}'

curl -X POST "https://api.chat.co/client/v1/conversations/CONVERSATION_ID/messages/stream?format=plain" \
  -H "Authorization: Bearer sk_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"message": "Tell me about your products"}' \
  --no-buffer

const axios = require('axios');

const API_KEY = 'sk_live_your_api_key';
const BASE_URL = 'https://api.chat.co/client/v1';

const client = axios.create({
  baseURL: BASE_URL,
  headers: {
    'Authorization': `Bearer ${API_KEY}`,
    'Content-Type': 'application/json'
  }
});

async function chat() {
  // 1. Create a new conversation
  const { data: convResponse } = await client.post('/conversations');
  const conversationId = convResponse.data.conversation.id;
  console.log('Created conversation:', conversationId);

  // 2. Send a message
  const { data: msgResponse } = await client.post(
    `/conversations/${conversationId}/messages`,
    { message: 'What services do you offer?' }
  );

  console.log('Bot response:', msgResponse.data.botResponse.content);
  console.log('Citations:', msgResponse.data.botResponse.citations);
}

chat();

import requests

API_KEY = 'sk_live_your_api_key'
BASE_URL = 'https://api.chat.co/client/v1'

headers = {
    'Authorization': f'Bearer {API_KEY}',
    'Content-Type': 'application/json'
}

# Create conversation
response = requests.post(f'{BASE_URL}/conversations', headers=headers, json={})
conversation_id = response.json()['data']['conversation']['id']
print(f'Created conversation: {conversation_id}')

# Send message
response = requests.post(
    f'{BASE_URL}/conversations/{conversation_id}/messages',
    headers=headers,
    json={'message': 'What are your pricing plans?'}
)

result = response.json()
print(f"Bot: {result['data']['botResponse']['content']}")

import requests

API_KEY = 'sk_live_your_api_key'
BASE_URL = 'https://api.chat.co/client/v1'

headers = {
    'Authorization': f'Bearer {API_KEY}',
    'Content-Type': 'application/json'
}

conversation_id = 'your_conversation_id'

# Stream response
response = requests.post(
    f'{BASE_URL}/conversations/{conversation_id}/messages/stream?format=plain',
    headers=headers,
    json={'message': 'Explain your features in detail'},
    stream=True
)

for chunk in response.iter_content(chunk_size=None, decode_unicode=True):
    if chunk:
        print(chunk, end='', flush=True)