Langkau ke kandungan
MS
Dapatkan kunci API
Semak dokumentasi

Rujukan API

Format respons

Pilih JSON terstruktur untuk aplikasi Anda atau konten Markdown untuk agen AI. Mengendalikan respon dengan dua header.

Pada halaman ini

Pilih format

JSON Diafine dengan hasil asli adalah standar. Accept memilih JSON atau teks biasa; X-Respond-With: markdown mengubah konten hasil ke Markdown. Tubuh permintaanmu tetap JSON.

ResponsAcceptX-Respond-WithPenggunaan Use for
JSONapplication/jsonJangan sertakanMedan Parsing dalam kode etik · baku
JSON + Markdownapplication/jsonmarkdownKonteks Agent struct dengan data meta terstruktur
Teks Plain Plaintext/plainJangan sertakanMedan orisinal Pembacaan fields dalam terminal
Teks Xina + Markdowntext/plainmarkdownData meta dan Markdown dibaca bersama-sama

Contoh permintaan dan tanggapan

Tab ini menunjukkan Google Search yang sama dalam setiap format. Use Bash dan cURL 7.76+ dengan FLASHDATA_API_KEY ditetapkan ke kunci yang memungkinkan google_search. Perintah menjalankan perintah mengirimkan satu pencarian yang dapat diagihkan.

Standar. Parase array hasil; bidang-bidang di dalamnya bergantung pada sumber.

Permintaan · cURL / Bash
curl --fail-with-body --silent --show-error \
  'https://data.flashdata.dev/v1/queries/realtime' \
  --header "X-API-Key: ${FLASHDATA_API_KEY:?Set FLASHDATA_API_KEY}" \
  --header 'Content-Type: application/json' \
  --header 'Accept: application/json' \
  --data '{"source":"google_search","query":"vector databases"}'
Contoh Contoh Contoh respon · nilai ilustrasi
{
  "source": "google_search",
  "status": "done",
  "results": [
    {
      "organic": [
        {
          "title": "Example page",
          "link": "https://example.com/article",
          "snippet": "A short source snippet."
        }
      ]
    }
  ],
  "usage": {
    "credits": 0.01
  },
  "created_at": "2026-10-22T12:00:00.000Z"
}

Titik akhir yang didukung

Aturan yang sama berlaku untuk Google Search dan YouTube sumber pertanyaan. Untuk YouTube Download, mereka memformat rekaman pengiriman, bukan video atau audio byte. API Akun API, manifes Bulk dan bagian NDJSON, callback dan respon MCP menggunakan format mereka sendiri.

Titik akhir Ukur¡JSON / teks biasaKandungan Markdown
POST /v1/queries/realtimeDidukungDidukung
GET /v2/jobs/{id}/resultsDidukungDidukung
POST /v1/queriesPenerimaan Penerimaan PenerimaanDiabaikan — pilihlah sewaktu membaca hasil
POST /v1/queries/batchPenerimaan Penerimaan PenerimaanDiabaikan — pilihlah sewaktu membaca hasil
GET /v2/jobs/{id}Status pekerjaanDiabaikan — tidak ada konten hasil di sini

Memformat hasil kerja yang selesai

** Set headers ketika membaca hasilnya, bahkan jika Anda menetapkan mereka pada penyerahan. Anda dapat mengakses JOB_ID ke pekerjaan yang telah selesai. GET ini membaca hasil yang telah ada tanpa mengajukan pertanyaan lain.

Format yang diminta oleh KANTORTanggapan hasil
JSON asli302 Fuhrer dengan penyimpanan yang ditandatangani URL Di lokasi. Kutip URL secara terpisah, tanpa X-API-Key. Hasil penyimpanan gondoglif mungkin dikompresi gzip.
Teks plain atau pilihan Markdown200 dengan tubuh yang diformat langsung dalam respon.
AKAN MENGAMBIL Markdown Di dalam JSON · cURL / Bash
curl --fail-with-body --silent --show-error \
  "https://api.flashdata.dev/v2/jobs/${JOB_ID:?Set JOB_ID}/results" \
  --header "X-API-Key: ${FLASHDATA_API_KEY:?Set FLASHDATA_API_KEY}" \
  --header 'Accept: application/json' \
  --header 'X-Respond-With: markdown'

Kesalahan format

Galat API tetap JSON atau application/problem+json, bahkan ketika Anda meminta teks biasa. XEHTTP sebelum menghurai format sukses.

Status / kodeFix
400 · unsupported_representationUse X-Respond-With: markdown atau abaikan header. Nilai-nilai seperti json atau teks tidak didukung.
406 · not_acceptableGuna Accept: application/json OR atau ORANG text/plain. text/markdown Dan application/xml Tidak didukung.

Rincian header Accept

Omit Accept atau kirim */* untuk mendapatkan JSON. Response menggunakan UTF-8. Rentang media dan bobot q tidak didukung; set karakter yang tidak didukung mengembalikan 406 kecuali padanan jangkauan yang dapat diterima lainnya. Content-Type: application/json menggambarkan tubuh permintaan, bukan respon.

Teks prefer, ijinkan JSON
Accept: text/plain; charset=utf-8, application/json;q=0.8