# Формати відповідей

Виберіть структуровану JSON для вашого застосування або Markdown для агента AI. Контроль відповіді з двома заголовками.

Канонічне посилання: https://flashdata.dev/uk/docs/guides/response-formats
Переглянуто: 2026-11-04 від FlashData

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

## Виберіть формат

JSON з оригінальними полями результату є за замовчуванням. Accept вибирає JSON або звичайний текст; X-Respond-With: розмітка перетворює вміст результату в Markdown. Ваш запит тіла залишається JSON.

| Відповідь | Accept | X-Respond-With | Зареєструватися |
| --- | --- | --- | --- |
| JSON | application/json | Оміт | Поле для батьків в коді · за замовчуванням |
| JSON + Markdown | application/json | markdown | Контекст агента з структурованими метаданими |
| Плайн текст | text/plain | Оміт | Читання оригінальних полів в терміналі |
| Текст + Markdown | text/plain | markdown | Читання метаданих та Markdown разом |


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

## Приклади запиту та відповіді

Ці вкладки показують той самий Google Search в кожному форматі. Використовуйте Bash і cURL 7.76+ з FLASHDATA_API_KEY встановити ключ, який дозволяє google_search. Запуск команди подає один вексельний пошук.

### JSON

За замовчуванням. Вкажіть масив результатів; поля всередині нього залежать від джерела.

#### Запит · 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"}'
```

#### Приклад відповіді · ілюстраційні значення

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

Читати вміст як Markdown string. Замінює результати; джерело, статус і використання залишаються доступні як JSON поля.

#### Запит · 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"}'
```

#### Приклад відповіді · ілюстраційні значення

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


### Плайн текст

Читати відповідь як текст. У ній зібрано оригінальні поля в відступному макеті, а не документ JSON.

#### Запит · 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"}'
```

#### Приклад відповіді · ілюстраційні значення

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


### Текст + Markdown

Читайте відповідь як текст: метадані спочатку, після чого Markdown зміст.

#### Запит · 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"}'
```

#### Приклад відповіді · ілюстраційні значення

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


- [автентифікації API](https://flashdata.dev/uk/docs/guides/headers-and-authentication/reference.md)
- [Google Search відповіді поля](https://flashdata.dev/uk/docs/sources/google_search/reference.md#response)

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

## Підтримувані кінцеві точки

Так само правила застосовуються до Google Search і YouTube. Для YouTube Download вони форматують запис доставки, не відео або аудіобайтів. API облікового запису, Bulk проявляється і NDJSON частини, виклики та відповіді MCP використовують власні формати.

| Навігація | JSON / звичайний текст | Markdown зміст |
| --- | --- | --- |
| POST /v1/queries/realtime | Підтримувані | Підтримувані |
| GET /v2/jobs/{id}/results | Підтримувані | Підтримувані |
| POST /v1/queries | При отриманні дозволів | Ignored — вибрати його при результатах читання |
| POST /v1/queries/batch | При отриманні дозволів | Ignored — вибрати його при результатах читання |
| GET /v2/jobs/{id} | Статус на сервери | Ignored — немає вмісту результату тут |


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

## Формат завершеного результату роботи

Встановлюємо заголовки при прочитуванні результату, навіть якщо ви налаштуєте їх на подачі. Налаштуйте JOB_ID до готової роботи, ви можете отримати доступ. Цей GET прочитав існуючі результати без подання іншого запиту.

| Заявка на формат | Відповідність результатів |
| --- | --- |
| Оригінальний JSON | 302 з підписаним сховищем URL в Місцезнаходження. Кишеня, що URL окремо, без X-API-Key. Зберігати результати можна за допомогою gzip-compressed. |
| Плайн текст або параметр Markdown | 200 з відформатованим тілом безпосередньо у відповідь. |

### Редагувати Markdown внутр. 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'
```

- [Переглянути оригінальний JSON · Python і cURL](https://flashdata.dev/uk/docs/reference/realtime-and-async/reference.md#results)

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

## Похибки форматів

API помилки залишаються JSON або application/problem+json, навіть якщо ви запитуєте звичайний текст. Перевірити статус HTTP перед оформленням формату успіху.

| Статус / код | Фіксація |
| --- | --- |
| 400 · unsupported_representation | Використовуйте X-Respond-With: розмітка або омикання заголовка. Значення, такі як джсон або текст не підтримується. |
| 406 · not_acceptable | Використовуйте Accept: application/json або text/plain. text/markdown і application/xml не підтримуються. |

- [Помилки й коди стану](https://flashdata.dev/uk/docs/errors/reference.md)

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

## Accept головки деталі

Omit Accept або відправити */*, щоб отримати JSON. Використання відгуків UTF-8. Підтримуються діапазони та ваги q; непідтримувані charset повертає 406, якщо інший прийнятний діапазон відповідає. Content-Type: application/json описує корпус запиту, а не відповідь.

### Зашифрувати текст, дозволити JSON

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

