API ドキュメント

quonel のAIツールは、すべて共通のAPIから使えます。認証キーを添えてJSONをPOSTするだけ。

概要

ベースURL：https://api.quonel.com

リクエスト・レスポンスはいずれも application/json。すべてのツールが同じ認証・同じ作法で使えます。

POST /inbox 問い合わせ一次対応

POST /classify テキスト分類

POST /review レビュー分析

認証

発行された API キーを Authorization ヘッダに付けます。キーはお問い合わせで発行します。

authorization

Authorization: Bearer <YOUR_API_KEY>

キーが無い・誤っている場合は 401 unauthorized を返します。キーはサーバ側で安全に保管し、ブラウザなど公開環境に置かないでください。

問い合わせ一次対応

POST /inbox

問い合わせ本文から、カテゴリ分類・優先度・一次返信の下書きをまとめて生成します。

リクエスト

フィールド	型	説明
`text`	string	問い合わせ本文（必須）
`categories`	string[]	分類ラベル（任意・既定=請求/配送/アカウント/不具合/その他）
`priorities`	string[]	優先度ラベル（任意・既定=高/中/低）
`draft`	boolean	返信ドラフトを作るか（任意・既定 true）
`limit_usd`	number	このリクエストのコスト上限（任意）

POST /inbox

curl -X POST https://api.quonel.com/inbox \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{"text":"先週注文した商品がまだ届きません。急いでいます。"}'

{
  "category": {"label": "配送", "confidence": 1.0, "source": "rule"},
  "priority": {"label": "高", "confidence": 0.65, "source": "miss"},
  "draft": {"text": "お問い合わせありがとうございます。配送状況を確認しますので…", "source": "miss"},
  "degraded": false
}

テキスト分類

POST /classify

テキストを、指定したラベルのいずれかに分類します。タグ付け・仕分け・モデレーションなどに。

リクエスト

フィールド	型	説明
`text`	string	分類対象（必須）
`labels`	string[]	ラベル候補（必須・2件以上）
`limit_usd`	number	コスト上限（任意）

POST /classify

curl -X POST https://api.quonel.com/classify \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{"text":"荷物がまだ届きません","labels":["請求・支払い","配送","その他"]}'

{
  "value": {"label": "配送", "confidence": 0.9},
  "confidence": 0.9,
  "source": "miss",
  "degraded": false,
  "flags": []
}

レビュー分析

POST /review

複数のレビューをまとめて分析し、各レビューの感情・観点と、全体の集計を返します（1回のリクエストで最大50件）。

リクエスト

フィールド	型	説明
`reviews`	string[]	レビュー本文の配列（必須・最大50件）
`aspects`	string[]	観点ラベル（任意・既定=品質/価格/接客・対応/配送/使いやすさ/その他）
`limit_usd`	number	コスト上限（任意）

POST /review

curl -X POST https://api.quonel.com/review \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{"reviews":["梱包も丁寧で大満足","配送が遅くて困りました"]}'

{
  "summary": {
    "total": 2,
    "sentiment": {"ポジティブ": 1, "中立": 0, "ネガティブ": 1},
    "aspect": {"品質": 1, "配送": 1, "価格": 0, ...}
  },
  "results": [
    {"review": "梱包も丁寧で大満足", "sentiment": "ポジティブ", "aspect": "品質"},
    {"review": "配送が遅くて困りました", "sentiment": "ネガティブ", "aspect": "配送"}
  ]
}

ヘルスチェック

GET /healthz

稼働確認用。認証不要で {"ok": true} を返します。

エラー

エラーは HTTP ステータス＋ {"error": "..."} で返します。

ステータス	error	意味
`401`	`unauthorized`	APIキーが無い/誤り
`413`	`payload_too_large`	リクエストが大きすぎる
`429`	`rate_limited`	レート上限に到達
`422`	（検証）	入力の形式が不正
`500`	`internal_error`	サーバ内エラー

多くのツールは、AI応答が不完全でも例外にせず degraded: true と要確認フラグで部分結果を返します（暴走・全断を防ぐ設計）。

レート・使用量上限

安全のため、レート制限（毎分の呼び出し数）と使用量上限を備えています。上限に達すると 429 を返します。各リクエストに limit_usd を付けてコストを自分で制限することもできます。想定を超える課金や乱用を、構造的に防ぎます。

料金

使った分だけの従量課金です。小さく始めて、必要な分だけ拡張できます。トライアル・料金の詳細はお問い合わせください。