Get started with Vindex Ai in minutes

Quick Start Guide

Get up and running with Vindex Ai Gateway in just a few minutes.

Prerequisites

Before you begin, you'll need:
  1. An Vindex Ai account (sign up at ai.vindex.ai)
  2. A code editor (VS Code recommended)
  3. Basic knowledge of REST APIs

Step 1: Create Your First Channel

  1. Log in to your Vindex Ai dashboard
  2. Click New Channel in the sidebar
  3. Enter your channel details:
  4. Select an AI model (we recommend Llama 3.3 70B for general use)
  5. Click Create Channel

Step 2: Get Your API Key

After creating your channel:
  1. Go to Channels in the dashboard
  2. Open your channel
  3. Copy the API Key from the channel overview card
⚠️ Important: Keep your API key secret. Never expose it in client-side code for public websites.

Step 3: Send a Live Request

Make your first live API call using cURL:
bash
curl -X POST https://ai.vindex.ai/api/chat \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{
    "message": "Hello! What can you help me with?",
    "session_id": "test-session-001"
  }'
You should receive a response like:
json
{
    "reply": "Hi! I'm here to help you with anything you need. How can I assist you today?",
    "session_id": "test-session-001"
}

Step 4: Add to Your Website

Option A: Embed the Chat Widget

Add this to your website's
text
<body>
:
html
<script>
    window.Vindex AiConfig = {
        siteId: 'YOUR_SITE_ID',
        position: 'bottom-right',
    };
</script>
<script src="https://cdn.ai.vindex.ai/widget.js"></script>

Option B: Use the API

See our Website Chat Guide for custom integration.

Next Steps

  • 📖 Read the API Reference for complete documentation
  • 🛠️ Explore Tools for advanced features
PreviousSystem GuideNextInstallation