yoftdocs

API ドキュメント

リファレンス

エラーコード、入力上限、レート制限、使用量の扱いを確認できます。

エラーコード

すべてのエラーは共通の envelope で返ります。request_id は利用ログと共通のため、問い合わせ時に添えてください。

エラーレスポンス
{
  "error": {
    "code": "invalid_request",
    "message": "horizon: Input should be less than or equal to 512",
    "request_id": "req_a1b2c3d4e5f67890a1b2c3d4e5f67890"
  }
}
HTTPコード説明
400invalid_requestリクエストボディのスキーマ・値・上限違反
401unauthorizedAPI キーの欠落・不正・失効
402payment_requiredクレジット残高不足
403forbidden権限不足
404not_found未定義のルート
405method_not_allowed許可されていない HTTP メソッド
413payload_too_largeリクエストボディがサイズ上限を超過
429rate_limitedレート制限超過 — バックオフして再試行してください
500internal_error予期しないサーバエラー
503model_unavailableモデルが利用できません — 時間をおいて再試行してください
504timeout推論がタイムアウトしました

エラーが解決しないときはヘルプの「予測が失敗する」を見てください。 新しいタブで開きます

入力上限

上限を超えたリクエストは 400 invalid_request で拒否されます。

項目値
1 系列あたりの点数16–2048
1 リクエストあたりの系列数最大 64
予測 horizon1–512
1 リクエストの総入力点数最大 131,072

レート制限

API キー単位のトークンバケット方式です: バースト 10 リクエスト、1 リクエスト/秒で回復(free tier)。超過時は 429 rate_limited を返します。

使用量

200 レスポンスの usage オブジェクトで、リクエストが消費したデータ点数を確認できます。同じ値が Usage ページの利用ログにも表示されます。

フィールド説明
input_points送信した全 series の入力点数の合計
output_points返却した点数の合計。エンドポイントごとに定義が異なります: forecast = horizon × series 数 / anomaly = 2 × (系列長 − test_start) の合計 / impute = 補完した点(null)の数の合計 / embed = 0
series_countリクエストに含まれる series の数