API Reference
Complete REST API documentation for integrating with WIIL Platform.
Base URL
https://api.wiil.io/v1
Authentication
All API requests require authentication using an API key passed in the request header:
X-Wiil-Api-Key: wiil_proj_your_api_key_here
Example Request:
curl https://api.wiil.io/v1/conversations \
-H "X-Wiil-Api-Key: wiil_proj_..." \
-H "Content-Type: application/json"
Learn more about Authentication →
API Endpoints
Dynamic Agents
Simplified single-call agent deployment — see the Dynamic Agent Setup Guide for the full walkthrough.
- Dynamic Phone Agent - Deploy a phone agent in a single call
- Dynamic Web Agent - Deploy a web agent in a single call
- Dynamic Setup Result - Retrieve a dynamic setup result
Account Management
- Organization Management - Organization settings and status
- Project Management - Project CRUD operations
Agent Configuration
- Agent Configuration Management - AI agent settings
- Instruction Configurations - Agent behavior and templates
- Deployment Configurations - Deployment units
- Deployment Channels - Communication channels
Telephony
- Phone Configuration Management - Phone setup
- Telephony Provider Management - Phone numbers and pricing
- Provisioning Configurations - STT/TTS pipeline
Catalog — Properties
- Business Locations - Physical business locations
- Properties - Property listings
- Property Categories - Property categorization
- Property Addresses - Property address records
- Property Inquiries - Property inquiry records
Catalog — Services & Appointments
- Business Services - Service catalog
- Service Categories - Service categorization
- Service Providers - Service provider records
- Appointment Field Configs - Appointment field configuration
Catalog — Products
- Product Management - Product catalog
- Product Sets - Product bundles
- Product Variant Axes - Variant axis definitions
- Product Pricing Rules - Product pricing rules
Catalog — Menu
- Menu Sets - Menu bundles
- Modifiers - Menu item modifiers
- Menu Pricing Rules - Menu pricing rules
Reservations
- Reservation Resources - Bookable resources
- Reservation Settings - Reservation configuration
- Floor Plans - Floor plan management
- Floor Plan Sections - Floor plan sections
- Floor Plan Definitions - Floor plan definitions
- Maintenance Blocks - Resource maintenance blocks
- Reservations - Resource reservations
- Table Reservations - Table reservations
- Room Reservations - Room reservations
- Rental Reservations - Rental reservations
- Table Assignments - Table assignments
- Room Assignments - Room assignments
- Rental Assignments - Rental assignments
Transactions
- Service Appointments - Appointment scheduling
- Product Orders - Product purchases
- Menu Orders - Food/beverage orders
- Tax Rules - Tax rule configuration
- Discount Rules - Discount rule configuration
Communications
- Communications - Communication requests
- Outbound Calls - Outbound voice calls
- Outbound Emails - Outbound emails
- Outbound SMS - Outbound SMS messages
- Outbound Templates - Outbound message templates
Customers
Customer identities and contact details — see Handling Customer Data for the access model and privacy practices.
- Customers - Customer management
- Customer Groups - Customer grouping
- Shipping Addresses - Customer shipping addresses
Platform
- Knowledge Sources - Knowledge base
- Conversation Configurations - Conversation settings
- Translation Sessions - Real-time translation
- Support Models - AI model configurations
HTTP Status Codes
| Code | Description |
|---|---|
| 200 | Success |
| 201 | Created |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 429 | Rate Limited |
| 500 | Server Error |
SDKs
- JavaScript/TypeScript -
npm install wiil-js - Python -
pip install wiil-python