API Reference #

{
  "data": {
    "widgetId": "wgt_123_abc456",
    "embedCode": "<script src=\"...\"></script>"
  }
}

{
  "data": {
    "widgetId": "wgt_123_abc456",
    "embedCode": "<script src=\"...\"></script>",
    "color": "#667eea",
    "greeting": "Hello! How can I help you today?",
    "borderRadius": 16,
    "buttonRadius": 50,
    "buttonText": "Chat",
    "font": "Arial",
    "title": "Chat with us"
  }
}

{
  "data": {
    "success": true
  }
}

{
  "data": {
    "response": "Our return policy allows returns within 30 days...",
    "sessionId": "sess_abc123"
  }
}

{
  "data": [
    {
      "id": "chunk_123",
      "title": "Return Policy",
      "textSnippet": "We accept returns within 30 days...",
      "fullContent": "Full content...",
      "score": 0.87,
      "documentId": "doc_1",
      "contentType": "page"
    }
  ],
  "meta": {
    "count": 1
  }
}

{
  "data": {
    "answer": "You can return items within 30 days...",
    "sources": [
      {
        "id": "chunk_123",
        "title": "Return Policy",
        "textSnippet": "We accept returns within 30 days...",
        "score": 0.87
      }
    ]
  },
  "meta": {
    "sourcesCount": 1
  }
}

{
  "data": {
    "id": 1,
    "documentId": "abc123",
    "enabled": true,
    "webhooks": [
      {
        "url": "https://hooks.example.com/lead",
        "active": true,
        "lead_statuses": ["success", "partial"],
        "headers": [{ "key": "Authorization", "value": "Bearer token123" }]
      }
    ],
    "inactivity_threshold_minutes": 10,
    "data_collection_parameters": {
      "name": "Extract visitor name",
      "email": "Extract email if provided"
    }
  }
}

{
  "data": {
    "id": 1,
    "documentId": "abc123",
    "status": "success",
    "webhook_response": [
      {
        "url": "https://hooks.example.com/lead",
        "success": true,
        "status": 200,
        "data": { "received": true }
      }
    ],
    "sent_at": "2025-07-07T18:30:00.000Z"
  }
}

{
  "data": [
    {
      "documentId": "abc123",
      "extracted_data": {
        "name": "John Doe",
        "email": "john@example.com"
      },
      "chat_summary": "Visitor asked about pricing and provided contact details.",
      "status": "success",
      "createdAt": "2025-07-07T18:30:00.000Z",
      "sent_at": "2025-07-07T18:31:00.000Z"
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "pageSize": 50,
      "total": 127,
      "pageCount": 3
    }
  }
}

{
  "data": [
    {
      "id": 1,
      "documentId": "abc123",
      "name": "No PII",
      "description": "Block requests asking for personal information",
      "severity": "high",
      "correction_prompt": "Please don't share personal information.",
      "response_override": null,
      "email_contacts": ["admin@example.com"],
      "enabled": true,
      "trigger_count": 3
    }
  ]
}

{
  "success": true
}

{
  "data": {
    "triggered": true,
    "rail": {
      "id": "abc123",
      "name": "No PII",
      "severity": "high"
    },
    "correction": "Please don't share personal information.",
    "override": null
  }
}

{
  "data": {
    "script": "You are a helpful assistant for ACME Corp..."
  }
}

{
  "success": true,
  "script": "You are a helpful assistant for ACME Corp. Always greet users warmly..."
}

{
  "data": {
    "enabled": true,
    "max_messages_per_session": 20,
    "cooldown_seconds": 60,
    "max_messages_per_minute": 5,
    "custom_message": ""
  }
}

{
  "data": {
    "enabled": true,
    "chat_threshold": 50
  }
}

{
  "data": {
    "message": "Analysis triggered successfully"
  }
}

{
  "data": {
    "account": "pro",
    "subscription": {
      "id": "sub_123",
      "status": "active",
      "currentPeriodEnd": 1720000000
    },
    "usage": {
      "current": 42,
      "limit": 1000,
      "remaining": 958,
      "percentUsed": 4
    },
    "limits": {
      "free": 100,
      "pro": 1000,
      "enterprise": 10000
    }
  }
}

{
  "data": {
    "history": [{ "month": 7, "year": 2025, "amount": 42, "label": "2025-07" }],
    "account": "pro",
    "limit": 1000
  }
}

{
  "api_key": "sk_a1b2c3d4...",
  "message": "API key generated successfully"
}

{
  "success": true,
  "message": "API key revoked successfully"
}

{
  "data": [
    { "id": "openai/gpt-4", "name": "GPT-4" },
    { "id": "anthropic/claude-3-opus", "name": "Claude 3 Opus" }
  ]
}

{
  "success": true,
  "llm_model": "openai/gpt-4",
  "llm_provider": "openai"
}

{
  "error": "Bad Request",
  "message": "Query param is required"
}

{
  "error": "Unauthorized",
  "message": "Authentication required. Use JWT token or api_key parameter"
}

{
  "error": "Not Found",
  "message": "Widget not found"
}

{
  "error": "Rate limit exceeded",
  "message": "You have exceeded the rate limit of 10 requests per minute for your free plan.",
  "retryAfter": 45
}

{
  "error": "Internal Server Error",
  "message": "An unexpected error occurred"
}