# Format respons

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

Referensi boonical: https://flashdata.dev/ms/docs/guides/response-formats
Diulas: 2026-11-04 oleh FlashData

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

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

| Respons | Accept | X-Respond-With | Penggunaan Use for |
| --- | --- | --- | --- |
| JSON | application/json | Jangan sertakan | Medan Parsing dalam kode etik · baku |
| JSON + Markdown | application/json | markdown | Konteks Agent struct dengan data meta terstruktur |
| Teks Plain Plain | text/plain | Jangan sertakan | Medan orisinal Pembacaan fields dalam terminal |
| Teks Xina + Markdown | text/plain | markdown | Data meta dan Markdown dibaca bersama-sama |


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

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

### JSON

Standar. Parase array hasil; bidang-bidang 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"}'
```

#### Contoh Contoh Contoh respon · nilai ilustrasi

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

Kandungan baca sebagai string Markdown. Ia menggantikan hasil; sumber, status dan penggunaan tetap tersedia sebagai medan 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"}'
```

#### Contoh Contoh Contoh respon · nilai ilustrasi

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

Bacalah tanggapan itu sebagai teks. Ini berisi bidang asli dalam bentangan terindentasi, 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"}'
```

#### Contoh Contoh Contoh respon · nilai ilustrasi

```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 Xina + Markdown

Baca tanggapan sebagai teks: metadata pertama, diikuti oleh konten 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"}'
```

#### Contoh Contoh Contoh respon · nilai ilustrasi

```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/ms/docs/guides/headers-and-authentication/reference.md)
- [medan respon Google Search](https://flashdata.dev/ms/docs/sources/google_search/reference.md#response)

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

## 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 biasa | Kandungan Markdown |
| --- | --- | --- |
| POST /v1/queries/realtime | Didukung | Didukung |
| GET /v2/jobs/{id}/results | Didukung | Didukung |
| POST /v1/queries | Penerimaan Penerimaan Penerimaan | Diabaikan — pilihlah sewaktu membaca hasil |
| POST /v1/queries/batch | Penerimaan Penerimaan Penerimaan | Diabaikan — pilihlah sewaktu membaca hasil |
| GET /v2/jobs/{id} | Status pekerjaan | Diabaikan — tidak ada konten hasil di sini |


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

## 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 KANTOR | Tanggapan hasil |
| --- | --- |
| JSON asli | 302 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 Markdown | 200 dengan tubuh yang diformat langsung dalam respon. |

### AKAN MENGAMBIL 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'
```

- [Asli JSON · Python Dan cURL](https://flashdata.dev/ms/docs/reference/realtime-and-async/reference.md#results)

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

## Kesalahan format

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

| Status / kode | Fix |
| --- | --- |
| 400 · unsupported_representation | Use X-Respond-With: markdown atau abaikan header. Nilai-nilai seperti json atau teks tidak didukung. |
| 406 · not_acceptable | Guna Accept: application/json OR atau ORANG text/plain. text/markdown Dan application/xml Tidak didukung. |

- [Ralat dan kod status](https://flashdata.dev/ms/docs/errors/reference.md)

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

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

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

