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​
- Dynamic Agents - Simplified single-call agent deployment
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
Business Services​
- Business Services - Service catalog
- Reservation Resources - Bookable resources
- Product Management - Product catalog
- Menu Management - Food/beverage menus
Transactions​
- Service Appointments - Appointment scheduling
- Reservations - Resource reservations
- Product Orders - Product purchases
- Menu Orders - Food/beverage orders
Other​
- Customers - Customer management
- 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