Skip to main content

Developer Documentation

Welcome to the WIIL Platform Developer Documentation. This comprehensive guide provides everything you need to integrate, build, and scale AI-powered conversational services.

🚀 Quick Links​

🎯 Getting Started

New to WIIL Platform? Start here to understand the architecture and make your first API call.

Get Started

📡 API Reference

Complete API documentation with endpoints, schemas, and code examples.

View API Docs

🏗️ Architecture

Deep dive into the platform architecture and understand how all components work together.

Explore Architecture

🔌 Guides

Step-by-step guides for integrating WIIL Platform with your applications and services.

View Guides

🌟 Platform Overview​

The WIIL Platform enables you to deploy and manage AI-powered conversational agents across multiple channels with advanced capabilities including voice processing, real-time translation, and business transaction management.

Core Capabilities​

FeatureDescription
Multi-Channel DeploymentDeploy agents to phone, web chat, SMS, and email from a single platform
Voice ServicesEnd-to-end voice processing with STT, TTS, and speech-to-speech capabilities
Real-Time TranslationMultilingual conversations with bidirectional voice-to-voice translation
Business ManagementIntegrated appointment booking, reservations, menu ordering, and product sales
AI Agent ConfigurationFlexible instruction-based agent behavior with role management
Conversations HubCentralized conversation management with analytics and summaries

Architecture Domains​

The platform is organized into four integrated domains:

┌─────────────────────────────────────────────────────────────┐
│                    WIIL PLATFORM                            │
├─────────────────────────────────────────────────────────────┤
│ 1. Service Configuration (Core)                             │
│    • Agent deployment & instruction management              │
│    • Multi-channel support                                  │
│                                                             │
│ 2. Advanced Service Configuration                          │
│    • Voice processing (STT → Agent → TTS)                   │
│    • Provisioning chain configurations                     │
│                                                             │
│ 3. Translation Services                                    │
│    • Real-time multilingual translation                    │
│    • Translation chain configurations                      │
│                                                             │
│ 4. Business Management                                     │
│    • Service catalogs & resource management                │
│    • Transactional operations                              │
│                                                             │
│ CENTRAL HUB: Conversations                                 │
│    • Bridges AI agents ↔ Business customers               │
└─────────────────────────────────────────────────────────────┘

Learn more about the architecture →

📚 Documentation Sections​

Getting Started​

Architecture Documentation​

API Reference​

Guides​

SDKs & Libraries​

Schemas & Reference​

🔑 API Overview​

Base URL​

https://api.wiil.io/v1

Authentication​

All API requests require authentication using an API key in the header:

curl https://api.wiil.io/v1/organizations \
  -H "X-WIIL-API-Key: your_api_key_here"

Learn more about authentication →

Response Format​

All API responses follow a consistent JSON format:

{
  "success": true,
  "data": {
    // Response data
  },
  "metadata": {
    "timestamp": 1704067200000,
    "version": "v1"
  }
}

Common HTTP Status Codes​

CodeDescription
200Success
201Created
400Bad Request
401Unauthorized
403Forbidden
404Not Found
429Rate Limit Exceeded
500Internal Server Error

View all status codes →

💡 Quick Start Example​

Here's a simple example to get you started:

// 1. Install the SDK
npm install @wiil/sdk

// 2. Initialize the client
import { WiilClient } from '@wiil/sdk';

const client = new WiilClient({
  apiKey: 'your_api_key_here'
});

// 3. Create a conversation
const conversation = await client.conversations.create({
  channel_id: 'channel_123',
  deployment_config_id: 'deploy_456',
  conversation_type: 'OTT_CHAT',
  channel_identifier: 'user@example.com'
});

// 4. Send a message
const response = await client.conversations.sendMessage(conversation.id, {
  message: 'Hello, I need help with my appointment',
  message_type: 'user'
});

console.log('AI Response:', response.message);

View complete quick start guide →

🆘 Support & Resources​

Getting Help​

Stay Updated​

🚀 Next Steps​

📖 Learn

Understand the platform architecture and core concepts

Read Architecture Guide

🛠️ Build

Start building with our API and SDKs

Start Quick Start

🚀 Explore

Browse the complete API reference

View API Reference

Ready to get started? Head over to the Quick Start Guide to make your first API call.