APIDocumentation
API reference and integration guide for incorporating Chat Saku's features into your system.
Integration Methods
Script Tag Embed
Add a single line of HTML to install the chatbot. The simplest method available.
<script src="https://widget.chat-saku.app/widget.js" data-api-key="YOUR_API_KEY" data-merchant-id="YOUR_MERCHANT_ID" async> </script>
REST API
Access chat functionality from external systems. Ideal for LINE integration or custom frontends.
curl -X POST https://api.chat-saku.app/api/v1/chat \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"message": "営業時間を教えてください",
"conversation_id": "optional-id"
}'WordPress Plugin
Install and configure from the WordPress admin panel. No code editing required.
// WordPress管理画面から // 1. プラグイン → 新規追加 // 2. "Chat Saku" を検索 // 3. インストール → 有効化 // 4. 設定画面でAPIキーを入力
Authentication
API Key Authentication
Used for chat API calls from the widget or server-side. You can obtain your API key from the Settings page in the dashboard.
Firebase Auth
Used for accessing the dashboard and merchant management APIs. Set the Firebase Auth token in the Authorization header.
Key Endpoints
| Method | Endpoint | Description | Auth |
|---|---|---|---|
| POST | /api/v1/chat | Send a chat message and receive an AI response. | API Key |
| GET | /api/v1/conversations | Retrieve a list of conversation history. | Firebase Auth |
| GET | /api/v1/conversations/:id | Get details and messages for a specific conversation. | Firebase Auth |
| GET | /api/v1/knowledge | Retrieve a list of knowledge base items. | Firebase Auth |
| POST | /api/v1/knowledge | Create a new knowledge item. | Firebase Auth |
| GET | /api/v1/analytics/overview | Retrieve chatbot analytics data. | Firebase Auth |
Rate Limits
Monthly conversation limits apply based on your plan. API calls are limited to 10 requests per second.
Webhook
Receive new conversations and lead information in real time. Available on the Enterprise plan.
Security
All communications are encrypted with TLS 1.3. API keys are stored hashed with SHA-256.
Get your API key and start building
API access is available even on the free Starter plan. Sign up now and get your API key.
Sign Up Free