Lewati ke isi
ID
Dapatkan kunci API
Jelajahi dokumentasi

Referensi API

Format respons

Pilih JSON terstruktur untuk aplikasi anda atau Markdown konten untuk agen AI. Kontrol respon dengan dua header.

Di halaman ini

Pilih suatu format

JSON dengan ruas hasil asli adalah yang baku. Accept memilih JSON atau teks biasa; X-Respond-With: markdown mengkonversi hasil konten ke Markdown. Tubuh permintaan Anda tetap JSON.

ResponsAcceptX-Respond-WithGunakan untuk
JSONapplication/jsonOmitRuas penguraian dalam kode
JSON + Markdownapplication/jsonmarkdownKonteks Agen dengan metadata terstruktur
Teks biasatext/plainOmitMembaca ruas asli dalam suatu terminal
Teks + Markdowntext/plainmarkdownMembaca metadata dan Markdown bersama

Contoh permintaan dan respon

Tab ini menunjukkan Google Search yang sama pada setiap format. Gunakan Bash dan cURL 7.76 + dengan FLASHDATA_API_KEY set ke kunci yang memungkinkan google_search. Menjalankan perintah menyerahkan satu pencarian yang bisa dihitung.

Default. Parse larik hasil; ruas 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"}'
Respon contoh
{
  "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 sumber permintaan YouTube. Untuk YouTube Download, mereka format catatan pengiriman, bukan video atau byte audio. APIS Akun, manifestasi Bulk dan bagian NDJSON, callbacks dan MCP menggunakan format mereka sendiri.

EndpointTeks JSON / plainIsi Markdown
POST /v1/queries/realtimeDidukungDidukung
GET /v2/jobs/{id}/resultsDidukungDidukung
POST /v1/queriesTanda terima submisiDiabaikan - pilih ketika membaca hasil
POST /v1/queries/batchTanda terima submisiDiabaikan - pilih ketika membaca hasil
GET /v2/jobs/{id}Status tugasDiabaikan - tidak ada isi hasil di sini

Memformat suatu hasil tugas yang selesai

Atur tajuk ketika membaca hasilnya, bahkan jika Anda mengatur mereka pada penyerahan. Set JOB_ID ke pekerjaan lengkap Anda dapat mengakses. GET ini membaca hasil yang telah ada tanpa mengirimkan permintaan lain.

Format yang dimintaRespon hasil
Asli JSON302 dengan sebuah penyimpanan yang ditandatangani URL di Lokasi. Ambil URL itu secara terpisah, tanpa X-API-Key. Hasil tersimpan mungkin terkompresi gzip-.
Teks biasa atau pilihan Markdown200 dengan tubuh terformat langsung dalam respon.
Ambil 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'

Format error

API error tetap JSON atau application/problem+json, bahkan ketika Anda meminta teks polos. Periksa status HTTP sebelum parsing format sukses.

Status / kodePerbaiki
400 · unsupported_representationGunakan X-Respond-With: markdown atau abaikan header. Nilai seperti json atau teks tidak didukung.
406 · not_acceptableGunakan Accept: application/json atau text/plain. text/markdown dan application/xml tidak didukung.

Accept rincian header

Abaikan Accept atau kirim * / * untuk mendapatkan JSON. Respon menggunakan UTF-8. Batas media dan q bobot didukung; sebuah charset yang tidak didukung mengembalikan 406 kecuali jangkauan lain yang diterima cocok. Content-Type: application/json menggambarkan tubuh permintaan, bukan respon.

Lebih suka teks, ijinkan JSON
Accept: text/plain; charset=utf-8, application/json;q=0.8