|

APIYI Request ID 確認ドキュメントがアップグレード・最適化:エラー原文とレスポンスヘッダーの2つの取得方法

APIYI Request ID 確認ドキュメントがアップグレード・最適化:エラー原文とレスポンスヘッダーの2つの取得方法

作者注:APIYI の Request ID 検索ドキュメントがアップグレードされました。本記事では、エラー発生時にどの文字列をコピーすべきか、どの ID が使えないのか、非同期動画の task_id をどう保存するのか、そしてログで見つからないときにどの資料を追加すべきかを明らかにします。

呼び出しでエラーが出てチケットを起票するとき、開発者はよく同じ問題で手が止まります。手元には確かに ID の文字列があるのに、カスタマーサポートがログで検索できないのです。原因は多くの場合、上流ベンダーの X-Request-Id をコピーしてしまい、APIYI 自身の X-Shellapi-Request-Id ではないことです。新しいドキュメントはこの問題を解決するために書き直されたもので、URL は docs.apiyi.com/faq/request-id-troubleshooting です。

これは表面的なドキュメント更新ではありません。旧版は「レスポンスヘッダー」から始まり、「通常」「おそらく」といった表現ばかりで、読み終えてもどこでコピーすればよいのか分かりませんでした。新版は順序を逆にしています。まず答えを示し、次に取得方法、最後にチケットのテンプレートです。

核心的な価値:本記事を読めば、10 秒以内に正しい Request ID を取得でき、どの ID が間違っているかも判別できます。ログに記録が見つからない場合も、どの資料を追加すべきかが分かります。

apiyi-request-id-docs-upgrade-ja-image-0


APIYI の Request ID ドキュメントは何が変わったのか

新版ドキュメントの最初の一文がその答えになっています。APIYI の Request ID はレスポンスヘッダーの X-Shellapi-Request-Id であり、エラー発生時にはエラーメッセージの末尾にも同じ値が付きます。旧ページにあった、x-request-id を「メモしておくと調査に便利」とする数か所の記述も、今回まとめて修正されました。

項目 内容
更新日時 2026-11-16
ドキュメントの場所 FAQ コーナー「Request ID 調査」の新版ページ
核心となる答え Request ID = レスポンスヘッダー X-Shellapi-Request-Id、エラーメッセージ末尾の (request id: ...) も同じ値
追加された内容 2 通りの取得方法、ID 対照表、コンソールログに ID が表示されない件、非同期動画の説明、見つからない場合の対処、チケットのテンプレート
セキュリティ上の注意 Request ID はキーではないため、チケットやチャット、スクリーンショットに貼り付けても問題ありません。外部に出すべきでないのは sk- で始まる完全な APIキー です
影響を受ける利用者 APIYI でテキスト、画像、Embedding、Claude Messages、Responses、非同期動画の各インターフェースを呼び出しているすべての開発者

ドキュメントの原文によると、このレスポンスヘッダー名は大文字・小文字を区別しません。成功したリクエスト、業務エラー、ストリーミングリクエストのいずれでも返されます。ストリーミングリクエストでは、レスポンスヘッダーは最初のデータチャンクより前に届きます。非同期動画インターフェースの送信時と問い合わせ時にも返されます。


APIYI の Request ID、どの文字列をコピーすべき?2つの経路

まず形式を確認しましょう。APIYI の Request ID は14桁の UTC 時刻で始まります。たとえば 2026111602224568279882196e93ae3kTS58ypN の場合、先頭14桁の 20261116022245 は 2026-11-16 02:22:45 UTC、つまり北京時間の 10:22:45 です。このプレフィックスを自分の呼び出し時刻と照合すれば、取り違えていないかはほぼ判断できます。

apiyi-request-id-docs-upgrade-ja-image-1

経路1:エラー JSON から直接コピーする

これはほとんどのクライアントユーザーに適した方法です。エラー発生時、エラー JSON の message フィールドの末尾には (request id: ...) が付きます。括弧の中の文字列を丸ごとコピーすればOKです。

  1. クライアントまたはログ出力から、完全なエラー JSON を見つけます。
  2. message フィールドの末尾を特定します。
  3. request id: の後ろにある文字列全体をコピーします。途中で切らないようにしてください。

コンソールログ:呼び出しは確認できるが Request ID は表示されない

多くの人はまずコンソールの「ログ」ページで ID を探そうとします。新版ドキュメントでは、このために専用の節が設けられています。ログページには X-Shellapi-Request-Id が表示されず、それで検索する入口もありません。

ログで確認できるのは、時刻、モデル、APIトークン名、ストリーミング/非ストリーミング、所要時間、ステータス、入力/出力 token、費用、グループ、倍率、IP です。これらは今回の呼び出しが APIYI に到達したか、どのモデルを使ったか、いくら課金されたかを確認するには十分ですが、障害報告の特定には使えません。

そのため障害報告の際、ID の入手元は2つだけです。エラー原文(経路1)とレスポンスヘッダー(経路2)です。ログは時刻・モデル・APIトークン・費用といった補足材料として使います。

経路2:コードでレスポンスヘッダーを読む

エラー収集を自動化する場合は、コード内でこのヘッダーを直接記録することをおすすめします。どの方法でも Base URL は https://api.apiyi.com/v1 です。

  1. cURL:curl -D headers.txt を付けてレスポンスヘッダーをファイルに書き出し、そのファイル内で x-shellapi-request-id を探します。一時的な調査なら curl -i で直接出力する方法もあります。
  2. Python requests:レスポンスオブジェクトを取得したら r.headers.get("x-shellapi-request-id") を読みます。成功時もエラー時も読み取れます。
  3. OpenAI SDK(Python):通常の戻り値の _request_id は x-request-id を読んでおり、APIYI では通常空です。正しい方法は client.chat.completions.with_raw_response.create(...) に切り替え、raw.headers.get("x-shellapi-request-id") を読み、raw.parse() で結果を取得します。エラー時は except openai.APIStatusError as e の中で e.response.headers を読みます。
  4. Node.js:fetch を使うときは res.headers.get("x-shellapi-request-id") を読みます。
  5. Postman:リクエスト送信後、レスポンスエリアの Headers タブを開き、X-Shellapi-Request-Id を探します。
  6. ブラウザフロントエンド:クロスドメイン呼び出しは CORS の制限を受け、JS からはこのヘッダーを読めません。バックエンドプロキシで記録するか、開発者ツールの Network → 該当リクエスト → Response Headers で確認します。

🚀 クイックスタート:自分のコードでこのヘッダーが読めるか確認したい場合は、APIYI apiyi.com の APIトークンで最小限のリクエストを1回送り、14桁の時刻で始まる ID を出力できるか見てみましょう。この手順で少量の token を消費するので、出力がとても短いプロンプトを選ぶとよいです。


APIYIのRequest IDではないIDとは

1つのレスポンスの中に「ID」がいくつも現れることがあり、多くのサポートチケットがこの段階で止まってしまいます。新版ドキュメントには対照表が掲載されているので、以下に要点をまとめます。

apiyi-request-id-docs-upgrade-ja-image-2

フィールド 由来 障害報告・ログ調査に使えるか 識別特征
X-Shellapi-Request-Id APIYI ✅ これが該当 14桁のUTC時間で始まる
X-Oneapi-Request-Id 中間層 ❌ ヘッダー名が異なる
X-Request-Id アップストリームのベンダー ❌ APIYIのログでは検索できない よく req_ で始まる、またはUUID
その他チャネルの独自ヘッダー チャネル ❌ ヘッダー名がさまざま
レスポンスボディの id Completion ID / Response ID ❌ chatcmpl-、resp_ で始まる
画像の generation_id 画像生成結果 ❌ レスポンスボディ内にある
task_id 非同期タスク ❌ Request IDではないが、一緒に提供する必要がある タスク確認、課金確認に使用

判断ルールはとても簡単です。先頭が14桁の時間になっていないものは、APIYIのRequest IDではありません。req_ で始まるIDを受け取った場合、リクエストがOpenAI公式に直接送られている可能性があります。その際はまず Base URL が https://api.apiyi.com/v1 になっているかを確認してください。


非同期動画の task_id と Request ID をどのように分けて保存するか

非同期動画には「送信」と「照会」の2段階があり、各段階で新しい X-Shellapi-Request-Id が返されます。さらにタスクIDも加わって混同しやすいため、新版ドキュメントでは、送信リクエストの Request ID とポーリングに使うタスクIDを別々に保存することを推奨しています。

モデル タスクIDの位置 照会エンドポイント 混同しやすいフィールド
Seedance レスポンスボディ最上位の id(フィールド名は task_id ではない) GET /seedance/api/v3/contents/generations/tasks/{id} —
Wan / HappyHorse output.task_id GET /v1/tasks/{task_id} レスポンスボディ内の request_id は上流のもので、APIYI のログにあるものではない

実際に保存する際は、各タスクについて3つのフィールドを保存することを推奨します。送信時の X-Shellapi-Request-Id、タスクID、送信時刻です。タスク照会時に返される Request ID は必要に応じて記録します。送信失敗時の障害報告には Request ID を使います。タスクが滞留している場合や課金に疑問がある場合は、タスク照会と課金照会の両方でタスクIDが必要です。


ログで Request ID が見つからないときに補う情報

ID を取得しても、ログで必ず見つかるとは限りません。新版ドキュメントでは「コンソールログに Request ID がない」を別節にしています。ほかの見つからないケースも、同様に対処できます。

状況 原因 補うべき情報
レスポンスを受け取る前にリクエストが失敗 DNS、TCP/TLS、プロキシ拒否、クライアントタイムアウトなどで、レスポンスヘッダーがそもそもない エラー原文、呼び出し時刻、ネットワーク環境の説明
クライアントに「リクエスト失敗」しか表示されない クライアントが元のエラーを表示していない パス1またはパス2でIDを取得する。ログでは呼び出しが到達したかどうかだけを確認できる
ID が req_ で始まる OpenAI 公式にリクエストが届いている可能性がある Base URL を確認して再試行する
ログでも検索できない 保存期間を超えている、またはIDを間違えている IDの形式を確認する。ログは当月と過去2か月分のみ保持

さらに、コンソール画面にはIDが表示されませんが、ログ照会APIでは request_id で検索できます。以下の表は2026-11-16の実呼び出し確認で、モデルは deepseek-flash と gpt-image-2、リクエスト送信先は https://api.apiyi.com/v1 です。

呼び出し HTTPステータス レスポンスヘッダー ログの request_id 検索結果
deepseek-flash 非ストリーミング 200 x-shellapi-request-id あり、x-request-id なし 消費レコードを正確に1件取得
deepseek-flash ストリーミング 200 あり。最初の data: ブロックより前に読み取れる —
gpt-image-2、size=999×999 400 message 末尾の request id と同じ値 エラー/リトライ記録が3行、消費行なし
存在しないモデル名 503 message 末尾の request id と同じ値 1行も検索できない

結論として、コンソールのログページには Request ID が表示されませんが、ログ照会APIでは request_id で「消費行」と「エラー行」を検索できます。ただし、毎回あるとは保証されません。リクエストがチャネルに到達した後、チャネル側で失敗した場合(パラメータエラーなど)は、エラー行が残ります。ゲートウェイ層でその場で拒否された場合(利用可能なチャネルがないなど)は、1行も残らないことがあります。見つからないときは、レスポンスヘッダーまたはエラー原文にあるIDと、呼び出し時刻を組み合わせて材料を補います。

サポートで再現が必要な場合は、APIYI apiyi.com で同じトークン、同じパラメータ群を使って再度呼び出すか、別のモデルに切り替えて同じエラーになるか比較できます。再現でもトークンを消費するため、各再現時の Request ID も併せて記録してください。

🎯 調査のヒント:エラーを再現するときは、Base URL を https://api.apiyi.com/v1 に固定し、毎回 X-Shellapi-Request-Id と呼び出し時刻を記録します。その後、IDと呼び出し時刻をまとめてサポートに渡し、バックエンドでIDから検索してもらうことで、エラーがゲートウェイ層で発生したのかチャネル層で発生したのかをより早く特定できます。


APIYI Request ID エラー報告チケットテンプレート

以下の項目をそのままサポートチケットにコピーして記入してください:

  • Request ID:14桁のタイムスタンプで始まる文字列
  • モデル:例:gpt-image-2
  • エンドポイント:例:POST /v1/chat/completions
  • 日時:タイムゾーン付き(例:2026-11-16 11:24:04 UTC+8)
  • HTTPステータス:例:400 / 503
  • エラーメッセージ:(request id: ...) を含む完全なエラー内容を貼り付けてください
  • 試したこと:例:モデルを変更済み、Base URLを確認済み、2回リトライ済み
  • task_id(非同期動画のみ):送信時に返されるタスクID

注意点が2つあります。完全なAPIキーは送信しないでください。リクエストボディや画像にプライバシー情報が含まれる場合は、マスキングしてから送信してください。


Request ID ドキュメント更新が開発者に与える影響

開発者への影響

  • エラー報告のやり取りを1往復減らせる:最初から正しいIDを伝えれば、サポートが改めて確認する必要がありません。
  • SDKユーザーは空の値を取得しない:_request_id の注意点と with_raw_response からの取得方法を明記しました。
  • 動画タスクを追跡できる:Request IDとタスクIDを別々に保存することで、タスク確認や課金確認の根拠になります。

旧ドキュメントを参照する際の注意点

一部のAPI機能ページ、ニュースページ、エラーログ保存系ページでは、今も x-request-id を「記録しておくと調査が楽になる」ものとして説明しています。このような説明を見た場合は、新版の Request ID ページを基準にしてください。コードテンプレート内の x-request-id も x-shellapi-request-id に置き換えてください。


よくある質問(FAQ)

Q1:APIYI の Request ID は結局どれなのか?

レスポンスヘッダーの X-Shellapi-Request-Id です。14桁のUTC時刻で始まります。エラーが発生した場合、エラーメッセージの末尾にある `(request id: …)` 内の値と同じものです。

Q2:Request ID を他の人に送っても安全ですか?

安全です。ドキュメントの原文どおり、Request ID はキーではないため、チケットやチャット、スクリーンショットに貼り付けても問題ありません。外部に出すのがNGなのは、`sk-` で始まる完全なAPIキーです。

Q3:OpenAI SDK で取得した ID が空になるのはなぜ?

SDK のデフォルトの `_request_id` は x-request-id を読み取っています。`with_raw_response` に切り替えるか、`APIStatusError` のレスポンスヘッダーから x-shellapi-request-id を取得してください。

Q4:正しい Request ID を取得できるか素早く確認する方法は?

1. APIYI apiyi.com で登録してAPIキーを取得します。新規ユーザーには無料のテスト枠があります。
2. Base URL を `https://api.apiyi.com/v1` に設定し、最小限のリクエストを1回送信します。
3. x-shellapi-request-id を出力し、毎回の呼び出しでこのIDが取得できることを確認します。ログページでは、今回の呼び出しが到達したかどうかと課金の有無しか確認できず、IDは表示されません。

Q5:3ヶ月前のエラーはまだ調べられますか?

通常は調べられません。ログは当月とその前の2か月分のみ保持されます。それより古い記録については、ご自身で保存した Request ID とエラー原文をもとに説明する必要があります。


APIYI Request ID の重要ポイント Key Takeaways

  • 唯一正しい ID:X-Shellapi-Request-Id。14桁のUTC時刻で始まります
  • 2つの取得方法:エラーメッセージからコピーする、コードでレスポンスヘッダーを読む(ログでは呼び出しの確認のみ可能で、IDは表示されません)
  • よくある誤取得:X-Request-Id、req_、chatcmpl-、resp_、UUIDは障害報告には使用できません
  • 動画は2つ保存:送信時のRequest IDとタスクIDを別々に保存します
  • ログは100%ではない:コンソール画面にはIDが表示されません。ゲートウェイがその場で拒否したリクエストは記録自体が残らない場合があるため、エラーメッセージの原文と時刻を追記してください
  • すぐに検証:APIYI apiyi.com で最小リクエストを1回送信すれば、このヘッダーが読み取れることを確認できます

まとめ

今回のAPIYI Request ID 查询ドキュメントのアップグレードは、核心的に3つのポイントに集約されます:

  1. 回答を先に提示:Request IDはX-Shellapi-Request-Idであり、エラーメッセージの末尾にも同じ値が含まれています。
  2. 誤ったIDの排除:対照表で中間層、上流、レスポンスボディ、タスクIDの違いを明確にしました。
  3. 取得できない場合の備え:4つの状況ごとに追加すべき材料を整理し、そのまま使えるチケットテンプレートも添付しています。

コード内のエラーログフィールドを今すぐx-shellapi-request-idに変更することをおすすめします。今後問題が発生した際は、IDと呼び出し時刻を併せてカスタマーサポートに伝え、バックエンドでIDから調査してもらい、完全な材料を揃えてチケットを提出してください。


📚 参考資料

  1. APIYI Request ID トラブルシューティングドキュメント(新版):本記事の根拠となる資料
  2. リンク:docs.apiyi.com/faq/request-id-troubleshooting
  3. 説明:2 種類の取得方法、コンソールログの説明、ID 対照表、非同期動画の説明、サポートチケットのテンプレートを収録

  4. ログの保存期間:ログ保持期間に関する説明

  5. リンク:docs.apiyi.com/faq/log-retention-policy
  6. 説明:エラー記録がまだ確認できるかどうかを確認するための資料

作者:APIYI 技術チーム
技術交流:APIYI apiyi.com のサイトトップページからぜひお問い合わせください。サポートチケットを送信する際に X-Shellapi-Request-Id を添付すると、処理を迅速に進められます

類似投稿