Errors

4XX系レスポンスは共通のJSON形式をもちます(5XX系は非JSON形式となる可能性がございます)。

レスポンスのHTTP status lineは一般的な HTTP レスポンスコードを基準にしています。

Response status	意味
200	リクエスト成功
400	必須パラメータの省略などパラメータに関するエラー
401	APIキーの認証エラー
404	存在しないAPIエンドポイント
429	レートリミットによるアクセス一時拒否
500	障害などKotobaサーバーでエラー発生
504	リクエストタイムアウト

error objectrequired

エラーの詳細。

typestringrequired

大まかなエラー種別

Example: invalid_request_error

codestringnullable

詳細なエラー内容の識別子

error.type	error.code	説明
invalid_request_error	invalid_url	404 無効なエンドポイントです
	invalid_api_key	401 不正なAPIキー
	invalid_json	無効なJSONです
	invalid_event	無効なイベントtypeです
	invalid_parameters	無効なパラメータです
	session_expired	client_secretでのセッションのquotaを使い果たした
limitation	timeout_error	requestがtimeoutした
	rate_limit_error	Rate Limit制限に達した
server_error	internal_error	弊社側のエラー

Example: invalid_json

messagestringrequired

code に対応した、実装者向けの説明文章

Example: 無効なJSONです

paramstringnullable

パラメータエラーの際に関連する引数名（カンマ区切り）

Example: null

Errors

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_json",
    "message": "無効なJSONです",
    "param": null
  }
}