Documentation

Quickstart

1. Sign up at vantyx.ai
2. Create your first AI agent
3. Upload your knowledge base (PDF, URL, or paste text)
4. Copy your embed snippet
5. Paste on your website — done

Authentication

All API requests require an API key. Your key looks like:

sx_live_xxxxxxxxxxxx

Include it in the Authorization header:

Authorization: Bearer sx_live_xxxxxxxxxxxx

Rate limits: Starter — 100 req/day · Pro — 10,000 req/day · Business — Unlimited

Widget Setup

Basic embed — one script tag:

<!-- Basic embed -->
<script src="https://vantyx.ai/widget.js"
  data-agent-id="YOUR_AGENT_ID">
</script>

Advanced configuration:

<!-- Advanced -->
<script>
  Vantyx.init({
    agentId: 'YOUR_AGENT_ID',
    position: 'bottom-right',
    primaryColor: '#ffffff',
    greeting: 'Hi! How can I help?'
  });
</script>

API Reference

Base URL: https://api.vantyx.ai/v1

Webhooks

Events you can subscribe to:

Example payload:

{
  "event": "escalation.created",
  "timestamp": "2026-02-26T23:00:00Z",
  "data": {
    "conversationId": "conv_xxx",
    "agentId": "agent_xxx",
    "reason": "payment_issue"
  }
}

Agent Config

Full configuration fields reference: