API ドキュメント
リファレンス
エラーコード、入力上限、レート制限、使用量の扱いを確認できます。
エラーコード
すべてのエラーは共通の envelope で返ります。request_id は利用ログと共通のため、問い合わせ時に添えてください。
エラーレスポンス
{
"error": {
"code": "invalid_request",
"message": "horizon: Input should be less than or equal to 512",
"request_id": "req_a1b2c3d4e5f67890a1b2c3d4e5f67890"
}
}| HTTP | コード | 説明 |
|---|---|---|
| 400 | invalid_request | リクエストボディのスキーマ・値・上限違反 |
| 401 | unauthorized | API キーの欠落・不正・失効 |
| 402 | payment_required | クレジット残高不足 |
| 403 | forbidden | 権限不足 |
| 404 | not_found | 未定義のルート |
| 405 | method_not_allowed | 許可されていない HTTP メソッド |
| 408 | request_timeout | リクエストボディの受信が15秒以内に完了しませんでした |
| 413 | payload_too_large | リクエストボディがサイズ上限を超過 |
| 429 | rate_limited | レート制限超過 — バックオフして再試行してください |
| 500 | internal_error | 予期しないサーバエラー |
| 503 | model_unavailable | モデルが利用できません — 時間をおいて再試行してください |
| 504 | timeout | 推論がタイムアウトしました |
入力上限
上限を超えたリクエストは 400 invalid_request で拒否されます。
| 項目 | 値 |
|---|---|
| 1 系列あたりの点数 | 16–2048 |
| 1 リクエストあたりの系列数 | 最大 64 |
| 予測 horizon | 1–512 |
| 1 リクエストの総入力点数 | 最大 131,072 |
レート制限
API キー単位のトークンバケット方式です: バースト 10 リクエスト、1 リクエスト/秒で回復(free tier)。超過時は 429 rate_limited を返します。
CSV アップロードの形式
Playground の「自分のデータで試す」が受け付ける CSV と、返す結果 CSV の形式。画面の見本と同じ列構成です。
| 項目 | 内容 |
|---|---|
| ファイル | カンマ区切り。UTF-8 か Shift_JIS。10 MB まで |
| 1 行目 | 見出し行。列名は自由(重複は _2, _3 … で一意化) |
| 日時の列 | 1 列(自動で推定。無くても可)。ISO 8601 の日時か日付のみ。オフセットの無い日時はブラウザのローカル時刻として読まれる。等間隔なら将来の時刻を補って結果に付ける |
| 値列 | 数値のみ。空欄・Infinity は不可。複数選ぶと 1 つの多変量タスクとして同時に予測(group を付けて送る) |
| 上限 | 16〜2048 行、値列は最大 64。API の入力上限と同じ |
| 扱い | ファイルはブラウザ内で読み、サーバへは選んだ数値列だけを送る。保存しない |
入力 CSV の例
timestamp,building_a_kw,building_b_kw,building_c_kw
2014-11-18T01:00:00Z,153.1,98.5,417.7
2014-11-18T02:00:00Z,148.1,97.1,387.1
2014-11-18T03:00:00Z,100.7,99.6,375.3結果 CSV の例(末尾)
timestamp,type,building_a_kw,building_b_kw,building_c_kw
2015-01-01T00:00:00Z,actual,71.8,72.2,299.8
2015-01-01T01:00:00Z,forecast,127.6,110.6,434.2
2015-01-01T02:00:00Z,forecast,130.7,76.2,347.2結果 CSV は実測行に続いて予測行を縦に並べ、type 列(actual / forecast)で区別します。予測行の時刻は入力の間隔で延長します。日付だけの列は日付だけ、秒までの Z 付き日時は同じ書式で、それ以外は UTC の ISO 8601 で書きます。オフセットの無い日時も予測行は UTC にし、夏時間の切り替わりでも時刻を区別できるようにします。実測行は元の値のままです。先頭が = + - @ のセルは数式として実行されないようクォートします。
使用量
200 レスポンスの usage オブジェクトで、リクエストが消費したデータ点数を確認できます。同じ値が Usage ページの利用ログにも表示されます。
| フィールド | 説明 |
|---|---|
| input_points | 送信した全 series の入力点数の合計 |
| output_points | 返却した点数の合計。エンドポイントごとに定義が異なります: forecast = horizon × series 数 / anomaly = 2 × (系列長 − test_start) の合計 / impute = 補完した点(null)の数の合計 / embed = 0 |
| series_count | リクエストに含まれる series の数 |