Unif API Docs

エラー

UnifAPI がエージェントと HTTP クライアントに返すすべてのエラー、その意味、そして回復方法。

エラーは、どの公開データ操作が呼び出されたかに関わらず、常に同じエンベロープで返ります:

{
  "error": {
    "type": "rate_limited",
    "message": "Workspace rate limit exceeded.",
    "request_id": "unif_5471f8cfa3814204a280b73df8c93167"
  }
}
  • error.type閉じた語彙 からのものです(下の表を参照) — 安定しており、機械可読で、エージェントとクライアントが分岐処理に使うのに安全です。
  • error.message は人間向けであり、予告なく変更される場合があります。
  • error.request_id は UnifAPI のトレース ID です。サポートリクエストに含めてください。
  • error.issuestype = validation_error の場合にのみ存在します — それは生の Zod issue リストです。

HTTP ステータスは type を反映します — クライアントは好きな方のシグナルを選べます。

リファレンス

ステータスtype発生する状況回復方法
400validation_errorリクエストがゲートウェイ側の検証に失敗した(不正なクエリ、欠落したボディフィールド)。error.issues を確認します。リクエストを修正します。
400invalid_id提供された id は構文上有効だったが、公開ソースに受け入れられなかった。実在する id を使用します。
401unauthorizedOAuth または API キーの資格情報が欠落、形式不正、失効、または無効化されている。再認証するか、キーをローテーションします。
404not_foundリソース(動画、ユーザー、ルームなど)が存在しない、削除済み、またはプライベートである。id を確認します。一部のリソースはプライベートで、設計上 404 になります。
429rate_limitedワークスペースまたはソースのレート制限を超過した。Retry-After に従います。レート制限 を参照してください。
500internal_errorUnifAPI 自体が失敗した(捕捉されない例外)。再試行して安全です。継続する場合は request_id を報告してください。
500response_shape_errorソースデータが公開されたスキーマと一致しなくなった。request_id を報告してください — ドリフトはバグです。
502upstream_error公開データソースが、UnifAPI が回復できないエラーを返した。error.message を確認します。
503upstream_unavailable公開データソースがタイムアウトしたか、到達不能である。指数バックオフで再試行します。

上の表は、現在のエラー語彙に対する公開された契約です。

検証エラーの構造

validation_error の場合、issues 配列は生の Zod issue リストを保持するため、エージェントや呼び出し元はエラーをフィールドに対応付けられます:

{
  "error": {
    "type": "validation_error",
    "message": "Request validation failed.",
    "issues": [
      {
        "code": "too_big",
        "maximum": 50,
        "type": "number",
        "inclusive": true,
        "path": ["limit"],
        "message": "Number must be less than or equal to 50"
      }
    ]
  }
}

常に request_id をログに記録する

すべてのエラーレスポンスは、UnifAPI が付与できる場合に request_id を保持します。それをログに記録し、サポートリクエストに含めてください。失敗した Skill の実行や HTTP 呼び出しをデバッグする最速の方法です。

このページの内容