Developer Documentation

Build and deploy AI-powered conversational agents with the Wiil Platform API and SDKs. This documentation covers everything from quick setup to advanced configurations.

---

Quick Start

Quick Setup Guide

Deploy AI agents with a single API call. The fastest way to get started.

Get Started

API Reference

Complete API documentation with endpoints, schemas, and examples.

View API Docs

---

Deploy in Seconds

TypeScript

import { WiilClient } from 'wiil-js';
import { BusinessSupportServices } from 'wiil-core-js';

const client = new WiilClient({
  apiKey: process.env.WIIL_API_KEY!
});

// Deploy a Phone Agent
const phone = await client.dynamicPhoneAgent.create({
  assistantName: 'Sarah',
  capabilities: [BusinessSupportServices.APPOINTMENT_MANAGEMENT],
});

console.log('Phone number:', phone.phoneNumber);

// Deploy a Web Agent
const web = await client.dynamicWebAgent.create({
  assistantName: 'Emma',
  websiteUrl: 'https://example.com',
  capabilities: [BusinessSupportServices.APPOINTMENT_MANAGEMENT],
});

console.log('Widget snippets:', web);

Python

import os
from wiil import WiilClient
from wiil.models.service_mgt import BusinessSupportServices

client = WiilClient(
    api_key=os.environ['WIIL_API_KEY']
)

# Deploy a Phone Agent
phone = client.dynamic_phone_agent.create(
    assistant_name='Sarah',
    capabilities=[BusinessSupportServices.APPOINTMENT_MANAGEMENT]
)

print('Phone number:', phone.phone_number)

# Deploy a Web Agent
web = client.dynamic_web_agent.create(
    assistant_name='Emma',
    website_url='https://example.com',
    capabilities=[BusinessSupportServices.APPOINTMENT_MANAGEMENT]
)

print('Widget snippets:', web)

View Full Setup Guide →

---

Documentation

Setup & Authentication

Guide	Description
Quick Setup Guide	Single-call agent deployment
Authentication	API key authentication
API Keys	Managing your API keys

Guides

Guide	Description
Dynamic Agent Setup	Complete guide for Phone & Web agents
Fundamental Configuration	Traditional multi-step setup
Voice Channels	Phone call integration
Web Channels	Web chat widget integration

Architecture

Section	Description
Architecture Overview	Platform architecture
Service Configuration	Core agent deployment
Translation Services	Multilingual translation
Business Management	Business services
Conversations	Central integration hub

Reference

Section	Description
API Reference	Complete REST API documentation
Dynamic Agents API	Dynamic agent setup endpoints
Schemas	Data models and definitions
SDKs	Official SDK documentation

---

API Overview

Base URL

https://api.wiil.io/v1

Authentication

All requests require an API key:

curl https://api.wiil.io/v1/organizations \
  -H "X-Wiil-Api-Key: your_api_key"

Response Format

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

HTTP Status Codes

Code	Description
200	Success
201	Created
400	Bad Request
401	Unauthorized
404	Not Found
429	Rate Limit Exceeded

---

SDKs

TypeScript / JavaScript

npm install wiil-js

Full TypeScript support, Promise-based API, Node.js 18+

Python

pip install wiil-python

Pydantic models, sync & async support, Python 3.9+

---

Support

• Console: https://console.wiil.io
• Email: dev-support@wiil.io
• GitHub: https://github.com/wiil-io/wiil-js/issues

---

Ready to build? Start with the Quick Setup Guide →