Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.vchata.com/llms.txt

Use this file to discover all available pages before exploring further.

​
VChata API Quickstart

This guide will help you make your first API call to VChata and create your first AI-powered social media campaign.

​
Prerequisites

Before you begin, you’ll need:
  • A VChata account (Sign up here)
  • Your API credentials
  • Basic knowledge of HTTP requests and JSON

​
Step 1: Get Your API Credentials

  1. Sign up for VChata at app.vchata.com
  2. Create an organization and complete the onboarding process
  3. Navigate to Settings > API Keys in your dashboard
  4. Generate a new API key and copy it securely
Keep your API key secure and never expose it in client-side code or public repositories.

​
Step 2: Make Your First API Call

Let’s start by getting information about your organization: 
curl -X GET "https://api.vchata.com/organizations" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

​
Step 3: Connect a Social Media Account

Connect a Facebook or Instagram account to start automating: 
curl -X POST "https://api.vchata.com/social/connect" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "platform": "FACEBOOK",
    "accessToken": "YOUR_FACEBOOK_ACCESS_TOKEN",
    "platformUserId": "YOUR_FACEBOOK_USER_ID",
    "platformUserName": "Your Page Name"
  }'

​
Step 4: Create Your First AI Agent

Now let’s create an AI agent that can automatically respond to comments and messages: 
curl -X POST "https://api.vchata.com/ai/agents/org_abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Customer Support Bot",
    "description": "AI agent for handling customer inquiries",
    "channels": ["DIRECT_MESSAGE", "COMMENT"],
    "autoResponse": true,
    "responseDelay": 30,
    "promptTemplateId": "template_123"
  }'

​
Step 5: Create a Campaign

Set up your first automated campaign: 
curl -X POST "https://api.vchata.com/campaigns/org_abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Summer Sale Campaign",
    "description": "Automated responses for summer sale inquiries",
    "pipelineId": "pipeline_123",
    "platform": "FACEBOOK",
    "socialAccountIds": ["social_123"],
    "keywords": [
      {
        "keyword": "summer sale",
        "matchType": "CONTAINS",
        "priority": 1
      }
    ]
  }'

​
Next Steps

Congratulations! You’ve successfully: ✅ Made your first API call
✅ Connected a social media account
✅ Created an AI agent
✅ Set up an automated campaign

Explore the API Reference

Dive deeper into all available endpoints and features.

Set up Webhooks

Learn how to receive real-time notifications about social media events.

JavaScript SDK

Use our official SDK for easier integration.

Authentication Guide

Learn about JWT tokens, rate limits, and security best practices.

​
Need Help?