|

Dokumentasi pencarian Request ID APIYI telah ditingkatkan dan dioptimalkan: dua cara memperolehnya dari teks kesalahan asli dan header respons

Dokumentasi pencarian Request ID APIYI telah ditingkatkan dan dioptimalkan: dua cara memperolehnya dari teks kesalahan asli dan header respons

Catatan penulis: Dokumentasi pencarian Request ID APIYI telah diperbarui. Artikel ini menjelaskan dengan gamblang string mana yang harus disalin saat terjadi error, ID mana yang tidak boleh dipakai, bagaimana menyimpan task_id video asinkron, serta materi apa saja yang perlu dilengkapi ketika log tidak dapat ditemukan.

Setelah panggilan gagal dan Anda mengajukan tiket, pengembang sering tertahan pada masalah yang sama: di tangan jelas ada sebuah string ID, tetapi tim support tidak bisa menemukannya di log. Penyebabnya biasanya karena menyalin X-Request-Id milik produsen upstream, bukan X-Shellapi-Request-Id milik APIYI sendiri. Dokumentasi versi baru ditulis ulang untuk menyelesaikan masalah ini, alamatnya docs.apiyi.com/faq/request-id-troubleshooting.

Ini bukan pembaruan dokumen yang sekadar berganti tampilan. Versi lama dimulai dari “header respons”, penuh dengan kata “biasanya” dan “mungkin”, dan setelah selesai membaca pun Anda tetap tidak tahu di mana harus menyalin. Versi baru membalik urutannya: beri jawaban dulu, lalu cara mengambilnya, terakhir template tiket.

Nilai inti: Setelah membaca artikel ini, Anda bisa mendapatkan Request ID yang benar dalam 10 detik, dan juga bisa mengenali ID mana yang salah. Ketika catatan tidak ditemukan di log, Anda juga tahu materi apa yang perlu dilengkapi.

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


Apa yang Berubah dalam Pembaruan Dokumentasi Request ID APIYI

Kalimat pertama di dokumentasi versi baru sekaligus jadi jawabannya: Request ID pada APIYI adalah X-Shellapi-Request-Id di header respons, dan saat terjadi error, nilai yang sama juga muncul di akhir pesan error. Di halaman lama, ada beberapa bagian yang menyebut x-request-id sekadar sebagai “catat dulu untuk memudahkan investigasi”; itu juga sekalian diperbaiki.

Informasi Detail
Waktu pembaruan 2026-11-16
Lokasi dokumentasi Halaman baru “Investigasi Request ID” di kolom FAQ
Jawaban inti Request ID = header respons X-Shellapi-Request-Id; (request id: ...) di akhir message error adalah nilai yang sama
Konten baru 2 cara mengambil ID, tabel padanan ID, ID tidak ditampilkan di log konsol, penjelasan video asinkron, langkah saat ID tidak ditemukan, templat tiket
Catatan keamanan Request ID bukan kunci API, jadi boleh ditempel di tiket, chat, maupun tangkapan layar; yang tidak boleh dibagikan ke luar adalah kunci API lengkap yang diawali sk-
Yang terdampak Semua developer yang memanggil API teks, gambar, Embedding, Claude Messages, Responses, dan video asinkron di APIYI

Menurut teks aslinya, nama header respons ini tidak peka huruf besar-kecil. Permintaan yang berhasil, error bisnis, dan permintaan streaming semuanya mengembalikannya; pada permintaan streaming, header respons sudah tiba sebelum blok data pertama. Endpoint video asinkron juga mengembalikannya, baik saat submit maupun saat query.


Request ID APIYI: String Mana yang Harus Disalin Sekarang — Dua Jalur

Kenali dulu formatnya: Request ID dari APIYI diawali 14 digit waktu UTC. Misalnya 2026111602224568279882196e93ae3kTS58ypN, 14 digit pertama 20261116022245 adalah 2026-11-16 02:22:45 UTC, alias 10:22:45 waktu Beijing. Cocokkan prefix ini dengan waktu pemanggilan Anda sendiri, dan pada dasarnya Anda bisa menebak apakah sudah mengambil string yang salah.

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

Jalur satu: salin langsung dari JSON error

Jalur ini cocok untuk sebagian besar pengguna klien. Saat terjadi error, di akhir field message pada JSON error akan ada potongan (request id: ...); salin seluruh string di dalam tanda kurung itu.

  1. Temukan JSON error lengkap di klien atau output log.
  2. Cari bagian akhir field message.
  3. Salin seluruh rangkaian karakter setelah request id:, jangan dipotong.

Log konsol: bisa memastikan pemanggilan, tapi tidak menampilkan Request ID

Banyak orang pertama-tama pergi ke halaman “Log” di konsol untuk mencari ID. Dokumentasi versi baru secara khusus menulis satu bagian: halaman log tidak menampilkan X-Shellapi-Request-Id, dan tidak ada pintu masuk pencarian berdasarkan header itu.

Yang bisa dilihat di log adalah waktu, model, nama token, streaming/non-streaming, durasi, status, token input/output, biaya, grup, pengali, IP. Semua ini cukup untuk memastikan apakah pemanggilan ini sampai ke APIYI, model mana yang dipakai, dan berapa biaya yang dipotong, tetapi tidak bisa dipakai sebagai acuan pelacakan saat melapor masalah.

Jadi saat melapor masalah, ID hanya punya dua sumber: teks error asli (jalur satu) dan header respons (jalur dua). Log dipakai untuk melengkapi bahan berupa waktu, model, token, dan biaya.

Jalur dua: baca header respons di dalam kode

Saat melakukan pengumpulan error otomatis, sebaiknya catat header ini langsung di dalam kode. Base URL untuk semua cara harus https://api.apiyi.com/v1.

  1. cURL: tambahkan curl -D headers.txt untuk menulis header respons ke file, lalu cari x-shellapi-request-id di file tersebut. Untuk penelusuran sementara bisa juga memakai curl -i yang langsung mencetak.
  2. Python requests: setelah mendapatkan objek respons, baca r.headers.get("x-shellapi-request-id"). Bisa dibaca baik saat sukses maupun saat error.
  3. OpenAI SDK (Python): _request_id pada nilai kembalian biasa membaca x-request-id, yang di APIYI umumnya kosong. Cara yang benar adalah beralih ke client.chat.completions.with_raw_response.create(...), baca raw.headers.get("x-shellapi-request-id"), lalu gunakan raw.parse() untuk mengambil hasilnya. Saat error, baca e.response.headers di dalam except openai.APIStatusError as e.
  4. Node.js: saat memakai fetch, baca res.headers.get("x-shellapi-request-id").
  5. Postman: setelah mengirim request, buka tab Headers di area respons, lalu temukan X-Shellapi-Request-Id.
  6. Frontend browser: pemanggilan lintas domain dibatasi CORS, sehingga JS tidak bisa membaca header ini. Anda bisa mencatatnya di proxy backend, atau melihatnya di developer tools Network → request tersebut → Response Headers.

🚀 Mulai cepat: ingin memastikan kode Anda bisa membaca header ini, gunakan token APIYI apiyi.com untuk mengirim satu request minimal, dan lihat apakah ID dengan awalan 14 digit waktu bisa dicetak. Langkah ini akan menghabiskan sedikit token, jadi sebaiknya pilih petunjuk dengan output sangat pendek.


ID mana yang bukan Request ID APIYI

Dalam satu respons bisa muncul beberapa jenis “ID” sekaligus, dan banyak tiket bantuan macet justru di langkah ini. Dokumentasi versi baru sudah memuat tabel perbandingannya, dan berikut poin-poin utamanya.

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

Field Sumber Bisa dipakai untuk laporan masalah & pencarian log Ciri pengenal
X-Shellapi-Request-Id APIYI ✅ Inilah yang benar Diawali waktu UTC 14 digit
X-Oneapi-Request-Id Lapisan perantara ❌ Nama header berbeda
X-Request-Id Pihak upstream asli ❌ Tidak bisa dicari di log APIYI Umumnya diawali req_ atau UUID
Header kustom dari channel lain Channel ❌ Nama header berbeda-beda
id di body respons Completion ID / Response ID ❌ Diawali chatcmpl-, resp_
generation_id pada gambar Hasil pembuatan gambar ❌ Ada di dalam body respons
task_id Tugas asinkron ❌ Bukan Request ID, tapi tetap harus disertakan Untuk menelusuri tugas dan biaya yang dipotong

Aturan penentuannya sederhana: kalau awalnya bukan waktu 14 digit, itu bukan Request ID milik APIYI. Kalau ID yang Anda terima diawali req_, kemungkinan permintaan langsung dikirim ke OpenAI resmi. Dalam kasus ini, periksa dulu apakah Base URL sudah ditulis sebagai https://api.apiyi.com/v1.


Cara Menyimpan task_id dan Request ID Video Asinkron Secara Terpisah

Video asinkron punya dua langkah, yaitu “submit” dan “query”. Setiap langkah mengembalikan X-Shellapi-Request-Id baru, ditambah satu ID tugas, sehingga mudah tercampur. Saran dari dokumentasi versi baru: simpan Request ID dari permintaan submit dan ID tugas yang dipakai untuk polling secara terpisah.

Model Lokasi ID tugas Antarmuka query Field yang mudah tertukar
Seedance id di level teratas body respons (field-nya tidak bernama task_id) GET /seedance/api/v3/contents/generations/tasks/{id} —
Wan / HappyHorse output.task_id GET /v1/tasks/{task_id} request_id di body respons adalah milik upstream, bukan yang ada di log APIYI

Saat menyimpan, sebaiknya setiap tugas menyimpan 3 field: X-Shellapi-Request-Id saat submit, ID tugas, dan waktu submit. Request ID yang dikembalikan saat query tugas bisa dicatat sesuai kebutuhan. Kalau submit gagal, gunakan Request ID untuk pelaporan masalah; kalau tugas macet atau ada pertanyaan soal pemotongan biaya, ID tugas dipakai baik untuk mengecek tugas maupun mengecek biaya.


Apa yang Perlu Dilengkapi Saat Request ID Tidak Ditemukan di Log

Walau ID sudah didapat, belum tentu bisa ditemukan di log. Dokumentasi versi baru mencantumkan bagian tersendiri untuk “tidak ada Request ID di log konsol”, dan beberapa situasi lain yang tidak ditemukan bisa ditangani dengan cara serupa.

Situasi Penyebab Apa yang perlu dilengkapi
Permintaan gagal sebelum menerima respons DNS, TCP/TLS, proxy menolak, timeout klien — tidak ada header respons sama sekali Teks error asli, waktu pemanggilan, penjelasan lingkungan jaringan
Klien hanya menampilkan “permintaan gagal” Klien tidak menampilkan error asli Ambil ID lewat jalur satu atau jalur dua; log hanya bisa memastikan apakah panggilan sampai
ID diawali req_ Mungkin tertuju ke OpenAI resmi Periksa Base URL lalu coba lagi
Tidak ditemukan di log juga Melewati periode retensi, atau salah ambil ID Cocokkan format ID; log hanya menyimpan bulan berjalan dan dua bulan kalender sebelumnya

Satu hal lagi: halaman konsol tidak menampilkan ID, tetapi API query log bisa mencari berdasarkan request_id. Tabel berikut adalah hasil pemeriksaan panggilan nyata pada 2026-11-16, dengan model deepseek-flash dan gpt-image-2, permintaan dikirim ke https://api.apiyi.com/v1.

Panggilan Status HTTP Header respons Hasil pencarian log berdasarkan request_id
deepseek-flash non-streaming 200 Ada x-shellapi-request-id, tidak ada x-request-id Pencarian presisi mengembalikan 1 catatan konsumsi
deepseek-flash streaming 200 Ada, bisa dibaca sebelum blok data: pertama —
gpt-image-2, size=999×999 400 Sama dengan request id di akhir message 3 baris catatan error/retry, tanpa baris konsumsi
Nama model yang tidak ada 503 Sama dengan request id di akhir message Tidak ada satu baris pun yang ditemukan

Kesimpulannya: halaman log konsol tidak menampilkan Request ID, tetapi API query log bisa menemukan “baris konsumsi” dan “baris error” berdasarkan request_id, dan tidak dijamin selalu ada. Permintaan yang sudah sampai ke channel lalu gagal di sisi channel (misalnya kesalahan parameter) akan meninggalkan baris error. Permintaan yang ditolak langsung di lapisan gateway (misalnya tidak ada channel tersedia) mungkin tidak meninggalkan satu baris pun. Kalau tidak ditemukan, gunakan ID dari header respons atau teks error asli, ditambah waktu pemanggilan sebagai bahan pelengkap.

Jika tim dukungan perlu mereproduksi, Anda bisa memanggil sekali lagi di APIYI apiyi.com dengan token yang sama dan parameter yang sama, atau mengganti model untuk membandingkan apakah error-nya sama. Reproduksi juga menghabiskan token, jadi ingat untuk mencatat Request ID dari setiap reproduksi.

🎯 Saran troubleshooting: Saat mereproduksi error, tetapkan Base URL ke https://api.apiyi.com/v1, dan catat X-Shellapi-Request-Id serta waktu pemanggilan setiap kali. Setelah itu berikan ID dan waktu pemanggilan kepada tim dukungan; tim backend akan mencari berdasarkan ID, sehingga lebih cepat memastikan apakah error terjadi di lapisan gateway atau lapisan channel.


Template Tiket Error Request ID APIYI

Kolom-kolom berikut bisa langsung disalin ke tiket dan diisi:

  • Request ID: deretan yang diawali timestamp 14 digit
  • Model: misalnya gpt-image-2
  • Endpoint: misalnya POST /v1/chat/completions
  • Waktu: sertakan zona waktu, misalnya 2026-11-16 11:24:04 UTC+8
  • Status HTTP: misalnya 400 / 503
  • Pesan error: tempel error lengkap, termasuk (request id: ...)
  • Yang sudah dicoba: misalnya sudah ganti model, sudah cek Base URL, sudah retry 2 kali
  • task_id (hanya video asinkron): ID tugas yang dikembalikan saat submit

Perhatikan dua hal: jangan kirim kunci API secara lengkap; kalau body request atau gambar berisi konten privat, desensitisasi dulu sebelum dikirim.


Dampak peningkatan dokumentasi Request ID bagi developer

Dampaknya bagi developer

  • Pelaporan bug lebih singkat: berikan ID yang benar sekali saja, tim support tidak perlu bertanya balik.
  • Pengguna SDK tidak lagi menerima nilai kosong: sudah dijelaskan jebakan _request_id dan cara mengambilnya lewat with_raw_response.
  • Tugas video bisa dilacak: Request ID dan ID tugas disimpan terpisah, jadi pengecekan tugas maupun pengecekan biaya punya dasar yang jelas.

Yang perlu diperhatikan saat membaca dokumentasi lama

Di sebagian halaman kapabilitas endpoint, halaman berita, dan halaman penyimpanan error, x-request-id masih ditulis sebagai objek yang “dicatat agar memudahkan penelusuran”. Kalau menemukan pernyataan seperti itu, jadikan halaman Request ID versi baru sebagai acuan. Di template kode, ganti juga x-request-id menjadi x-shellapi-request-id.


Pertanyaan Umum (FAQ)

Q1: Request ID APIYI sebenarnya yang mana?

Itu adalah X-Shellapi-Request-Id di header respons, yang diawali dengan waktu UTC 14 digit. Saat terjadi error, nilai di bagian akhir pesan error `(request id: …)` sama dengan itu.

Q2: Apakah aman membagikan Request ID kepada orang lain?

Aman. Sesuai teks dokumentasi aslinya, Request ID bukan kunci rahasia, jadi boleh ditempel ke tiket, chat, atau tangkapan layar. Yang tidak boleh dibagikan ke luar adalah API Key lengkap yang diawali `sk-`.

Q3: Mengapa ID yang dibaca dari OpenAI SDK kosong?

`_request_id` bawaan SDK membaca x-request-id. Cukup gunakan `with_raw_response`, atau ambil x-shellapi-request-id dari header respons `APIStatusError`.

Q4: Bagaimana cara cepat memverifikasi bahwa saya bisa mendapatkan Request ID yang benar?

1. Daftar di APIYI apiyi.com dan dapatkan kunci API; pengguna baru mendapat kuota uji coba gratis.
2. Setel Base URL ke `https://api.apiyi.com/v1`, lalu kirim satu permintaan minimal.
3. Cetak x-shellapi-request-id dan pastikan Anda mendapatkan rangkaian ID ini di setiap pemanggilan; halaman log hanya bisa memverifikasi apakah pemanggilan ini sampai dan apakah biayanya terpotong, tetapi tidak menampilkan ID.

Q5: Apakah error dari tiga bulan lalu masih bisa dicek?

Biasanya tidak bisa. Log disimpan untuk bulan berjalan dan dua bulan kalender sebelumnya; catatan yang lebih lama harus Anda jelaskan sendiri dengan Request ID dan teks error asli yang Anda simpan.


Poin Penting Request ID APIYI

  • Satu-satunya ID yang benar: X-Shellapi-Request-Id, diawali dengan waktu UTC 14 digit
  • Dua cara mengambilnya: salin dari pesan error, atau baca header respons lewat kode (log hanya bisa memastikan pemanggilan terjadi, tidak menampilkan ID)
  • Kesalahan umum mengambil ID yang salah: X-Request-Id, req_, chatcmpl-, resp_, dan UUID semuanya tidak bisa dipakai untuk melapor
  • Untuk video wajib simpan dua: Request ID saat submit dan Task ID disimpan terpisah
  • Log tidak selalu 100%: halaman konsol tidak menampilkan ID; request yang langsung ditolak gateway bisa jadi bahkan tidak punya catatan, jadi perlu melampirkan teks error asli dan waktunya
  • Verifikasi langsung: kirim satu request minimal di APIYI apiyi.com untuk memastikan header ini bisa dibaca

Ringkasan

Peningkatan dokumentasi pencarian Request ID APIYI kali ini intinya ada tiga hal:

  1. Jawaban langsung di depan: Request ID adalah X-Shellapi-Request-Id, dan nilai yang sama juga ada di akhir pesan error.
  2. Penyisihan ID yang salah: tabel perbandingan memperjelas perbedaan antara lapisan perantara, upstream, body respons, dan Task ID.
  3. Ada rencana cadangan kalau tidak ditemukan: untuk empat situasi dijelaskan materi apa yang perlu dilampirkan, plus template tiket yang bisa langsung dipakai.

Saran: sekarang juga ubah field log error di kode menjadi x-shellapi-request-id. Setelah itu kalau ada masalah, berikan ID beserta waktu pemanggilan ke tim dukungan, biar backend mencarinya berdasarkan ID, lalu ajukan tiket dengan materi yang lengkap.


📚 Referensi

  1. Dokumentasi Troubleshooting Request ID APIYI (versi baru): dasar fakta artikel ini
  2. Tautan: docs.apiyi.com/faq/request-id-troubleshooting
  3. Penjelasan: mencakup dua cara pengambilan ID, penjelasan log konsol, tabel pemetaan ID, penjelasan video asinkron, dan templat tiket

  4. Berapa lama log disimpan: penjelasan periode retensi log

  5. Tautan: docs.apiyi.com/faq/log-retention-policy
  6. Penjelasan: untuk memastikan catatan error masih bisa dicek atau tidak

Penulis: Tim Teknis APIYI
Diskusi teknis: Silakan hubungi kami di halaman utama situs APIYI apiyi.com. Saat mengirim tiket, sertakan X-Shellapi-Request-Id untuk mempercepat pemrosesan

Similar Posts