# Format respons

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

Referensi kanonikal: https://flashdata.dev/id/docs/guides/response-formats
Diulang: 2026-11-04 oleh FlashData

<a id="headers"></a>

## 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.

| Respons | Accept | X-Respond-With | Gunakan untuk |
| --- | --- | --- | --- |
| JSON | application/json | Omit | Ruas penguraian dalam kode |
| JSON + Markdown | application/json | markdown | Konteks Agen dengan metadata terstruktur |
| Teks biasa | text/plain | Omit | Membaca ruas asli dalam suatu terminal |
| Teks + Markdown | text/plain | markdown | Membaca metadata dan Markdown bersama |


<a id="examples"></a>

## 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.

### JSON

Default. Parse larik hasil; ruas di dalamnya bergantung pada sumber.

#### Permintaan cURL / Bash

```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

```json
{
  "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"
}
```


### JSON + Markdown

Baca konten sebagai string Markdown. Ini menggantikan hasil; sumber, status, dan penggunaan tetap tersedia sebagai field JSON.

#### Permintaan cURL / Bash

```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' \
  --header 'X-Respond-With: markdown' \
  --data '{"source":"google_search","query":"vector databases"}'
```

#### Respon contoh

```json
{
  "source": "google_search",
  "status": "done",
  "usage": {
    "credits": 0.01
  },
  "created_at": "2026-10-22T12:00:00.000Z",
  "content": "# Google search\n\n## Organic\n\n### 1. Example page\n\n**Link:** <https://example.com/article>\n\n**Snippet:** A short source snippet\\.\n"
}
```


### Teks biasa

Baca responnya sebagai teks. Ini berisi bidang asli dalam layout yang tidak berpenyok, bukan dokumen JSON.

#### Permintaan cURL / Bash

```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: text/plain' \
  --data '{"source":"google_search","query":"vector databases"}'
```

#### Respon contoh

```text
Source: "google_search"
Status: "done"
Results:
  1:
    Organic:
      1:
        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"
```


### Teks + Markdown

Baca respon sebagai teks: metadata pertama, diikuti oleh isi Markdown.

#### Permintaan cURL / Bash

```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: text/plain' \
  --header 'X-Respond-With: markdown' \
  --data '{"source":"google_search","query":"vector databases"}'
```

#### Respon contoh

```text
Source: "google_search"
Status: "done"
Usage: {"credits":0.01}
Created at: "2026-10-22T12:00:00.000Z"

Markdown Content:
# Google search

## Organic

### 1. Example page

**Link:** <https://example.com/article>

**Snippet:** A short source snippet\.
```


- [Otentikasi API](https://flashdata.dev/id/docs/guides/headers-and-authentication/reference.md)
- [Google Search ruas respon](https://flashdata.dev/id/docs/sources/google_search/reference.md#response)

<a id="supported-endpoints"></a>

## 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.

| Endpoint | Teks JSON / plain | Isi Markdown |
| --- | --- | --- |
| POST /v1/queries/realtime | Didukung | Didukung |
| GET /v2/jobs/{id}/results | Didukung | Didukung |
| POST /v1/queries | Tanda terima submisi | Diabaikan - pilih ketika membaca hasil |
| POST /v1/queries/batch | Tanda terima submisi | Diabaikan - pilih ketika membaca hasil |
| GET /v2/jobs/{id} | Status tugas | Diabaikan - tidak ada isi hasil di sini |


<a id="completed-results"></a>

## 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 diminta | Respon hasil |
| --- | --- |
| Asli JSON | 302 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 Markdown | 200 dengan tubuh terformat langsung dalam respon. |

### Ambil Markdown di dalam JSON · cURL / Bash

```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'
```

- [Ambil yang asli JSON · Python dan cURL](https://flashdata.dev/id/docs/reference/realtime-and-async/reference.md#results)

<a id="errors-and-scope"></a>

## Format error

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

| Status / kode | Perbaiki |
| --- | --- |
| 400 · unsupported_representation | Gunakan X-Respond-With: markdown atau abaikan header. Nilai seperti json atau teks tidak didukung. |
| 406 · not_acceptable | Gunakan Accept: application/json atau text/plain. text/markdown dan application/xml tidak didukung. |

- [Kesalahan dan kode status](https://flashdata.dev/id/docs/errors/reference.md)

<a id="negotiation"></a>

## 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

```http
Accept: text/plain; charset=utf-8, application/json;q=0.8
```

