リクエスト情報

メソッド: POST
エンドポイント: **https://api-mebo.dev/api**

ヘッダー

Key	Value
Content-Type	application/json

パラメータ

パラメータ	説明	型	必須
api_key	APIキー	String	○
agent_id	エージェントID	String	○
utterance	ユーザの発話	String	○
uid	ユーザ識別子	String
state	ユーザーステート	Object
stream	ストリームの利用(SSE)
利用方法は下記資料を参照	Bool
start_utterance	会話開始時の発話	String

uid: 「シナリオ対話機能」、「ステート」を利用する場合は必須。一意にならない場合、ユーザ情報が正常に保持されない可能性あり。例：「サービス名_ユニークな文字列」
stream: true指定でストリーム形式応答。利用する場合は、エージェント設定画面で「ストリームの利用」を有効にしてください。
state: Key, Valueを指定してステート情報を追加する事が可能。登録可能な値はStringのみ。例:


{
  "username": "太郎",
  "age": "28歳",
}

Curlサンプル


curl -H "Content-Type: application/json" -X POST -d '{"api_key":"<api key>","agent_id":"<agent_id>","utterance":"<発話>","uid":"mebo.ai_sample_001"}' <https://api-mebo.dev/api>

レスポンス情報

ステータスコード

ステータスコード	説明
200	リクエスト成功
400	Bad Request リクエストに問題
401	Unauthorized 認証エラー
404	Not Found 存在しないエンドポイント
429	Too Many Requests リクエストの超過
500	Internal Server Error サーバーのエラー
503	Service Unavailable サービスが利用できない

レスポンスボディ (サンプル)

{
    "utterance": "ニックネームはなんですか？",
    "bestResponse": {
        "utterance": "ジョンと呼んでください！",
        "options": [
            "他の話題",
            "プロフィールについて",
        ],
        "topic": "プロフィールについて",
	    "isAutoResponse": false,
	    "extensions": null
		}
}