Skip to main content

​
Quickstart

Build your first conversational application with Plati AI in under 5 minutes.
What you’ll build: A complete conversational application with a Worker containing an AI assistant, connected to WhatsApp, ready to handle real conversations automatically.

​
Before You Start

You’ll need:
  • Plati AI access - Contact our team to get started
  • WhatsApp Business Account - With Meta Business Manager access
  • 5 minutes of your time
  • Basic knowledge of APIs (we’ll provide all the code)
Getting Started: Plati AI is currently invite-only. Contact our team at plati.ai to discuss your use case and get access to the platform.

​
Step 1: Get Your API Key

1

Contact Plati AI

Reach out to our team at plati.ai to discuss your project and get access to the platform.
2

Receive Workspace Access

Our team will set up your workspace and provide you with the necessary credentials.
3

Get Your API Key

Once your workspace is ready, you’ll receive your API key with appropriate permissions for your use case.
Keep it safe: Never expose your API key in client-side code or public repositories.

​
Step 2: Create Your Worker

A Worker is your conversational application container that can hold multiple assistants. 
curl -X POST https://api.plati.ai/workers \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Customer Support App",
    "description": "Main customer service conversational application",
    "timezone": "America/New_York"
  }'
Save the worker_id from the response - you’ll need it for the next step.

​
Step 3: Add an Assistant to Your Worker

Now let’s add an AI assistant to your worker: 
curl -X POST https://api.plati.ai/workers/WORKER_ID/assistants \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Support Assistant",
    "languages": ["en-US"],
    "provider": "OPENAI",
    "model": "gpt-4",
    "instructions": "You are a helpful customer service assistant."
  }'
Save the assistant_id from the response.

​
Step 3.5: Configure Assistant Prompt (Prompt Engineering)

Now let’s refine your assistant’s instructions with better prompt engineering: 
curl -X PATCH https://api.plati.ai/assistant/ASSISTANT_ID \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "instructions": "You are a helpful customer service assistant for an e-commerce company. Be friendly, concise, and always try to solve the customer'\''s problem. If you can'\''t help, explain that you'\''ll connect them with a human agent. Always greet customers warmly and ask how you can help them today."
  }'
Prompt Engineering: This is where you define your assistant’s personality, behavior, and capabilities. See our Prompt Engineering Guide for advanced techniques.

​
Step 3.6: Add Skills to Assistant (Optional)

You can extend your assistant’s capabilities by connecting MCP (Model Context Protocol) servers that provide custom functions: 
# First, create an MCP server (if you have one)
curl -X POST https://api.plati.ai/workspace/mcps \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Order Management",
    "transport": "http",
    "url": "https://your-mcp-server.com/mcp",
    "headers": [
      {
        "key": "Authorization",
        "value": "Bearer YOUR_MCP_KEY"
      }
    ]
  }'

# Then connect it to your assistant
curl -X PUT https://api.plati.ai/assistant/ASSISTANT_ID/mcp/MCP_ID \
  -H "Authorization: Bearer YOUR_API_KEY"
Skills are optional: You can skip this step if you don’t need custom functions. See our MCP Guide to learn more about extending assistants with custom capabilities.

​
Step 4: Create WhatsApp Channel

Before starting conversations, you need to create a WhatsApp channel connected to your Meta Business account: 
curl -X POST https://api.plati.ai/channels/waba \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Production WhatsApp",
    "accessToken": "YOUR_META_ACCESS_TOKEN",
    "phoneNumberId": "YOUR_PHONE_NUMBER_ID",
    "businessId": "YOUR_BUSINESS_ID",
    "integration": "Plati_infra"
  }'
Meta Credentials: You’ll need these from your Meta Business Manager:
  • Access Token: From your WhatsApp Business API app
  • Phone Number ID: Your WhatsApp Business phone number ID
  • Business ID: Your Meta Business account ID
See our WhatsApp Integration Guide for detailed setup instructions.
Now sync your worker to the channel: 
curl -X POST https://api.plati.ai/channels/CHANNEL_ID/worker/WORKER_ID \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Step 5: Create a Contact

Create a contact that will be aggregated into an identity. An identity groups multiple contacts (phone, email, etc.) into a single user profile: 
curl -X PUT https://api.plati.ai/identity/contact_123 \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "John Doe",
    "phone": "+5511999999999",
    "email": "[email protected]"
  }'
Identity Aggregation: When you create a contact with a phone number or email, it’s automatically aggregated into an identity. If the identity already exists, the contact is added to it. This allows you to have multiple contact points (phone, email, etc.) for the same user.

​
Step 6: Start Conversations

Conversations are created automatically when someone sends a message to your WhatsApp channel! You don’t need to manually create conversations.

​
How It Works

  1. User sends message to your WhatsApp Business number
  2. Plati receives the message via webhook
  3. Contact is identified (or created if new)
  4. Contact is aggregated into an identity
  5. Conversation starts automatically and routes to your worker/assistant
  6. Assistant responds based on its instructions

​
Test It Out

Simply send a WhatsApp message to your connected phone number: 
Hello! I need help with my order.
Your assistant will automatically:
  • Receive the message
  • Process it with context
  • Generate a response
  • Send it back via WhatsApp
Success! Your conversational application is now live! Conversations are created automatically when users message your WhatsApp channel.

​
What You Just Built

Workspace

Your isolated environment with configurations and permissions

Worker

A conversational application that can contain multiple assistants

Assistant

The AI brain with prompt-engineered instructions and optional skills

Channel

WhatsApp Business channel connected to Meta

Contact

A contact point (phone/email) aggregated into an identity

Identity

Aggregation of multiple contacts representing a single user

​
Understanding the Architecture

Your setup follows Plati’s architecture:
Automatic Conversations: When a user sends a WhatsApp message, Plati automatically creates the conversation, identifies or creates the contact, aggregates it into an identity, and routes it to your worker/assistant.

​
Next Steps

WhatsApp Integration

Learn more about WhatsApp setup and templates

Prompt Engineering

Master advanced prompt techniques

Add Functions (MCP)

Extend your assistant with custom functions

API Reference

Explore all available endpoints

​
Pro Tips

Consider creating different assistants within the same worker for:
  • Primary Support: Handle general inquiries
  • Sales Assistant: Focus on conversion and upselling
  • Follow-up Assistant: Manage scheduled tasks and reminders
Start with WhatsApp, then expand:
  • WhatsApp for customer support
  • Email for formal communications
  • Webhooks for custom integrations
  • Contacts are individual contact points (phone, email)
  • Identity aggregates multiple contacts into one user profile
  • Use identity stages to customize behavior (Lead, Consumer, Partner)

​
Need Help?

API Reference

Complete documentation for all endpoints

Troubleshooting

Common issues and solutions