# Форматы ответов

Выберите структурированный JSON для вашего приложения или Markdown для агента ИИ. Контролируйте ответ двумя заголовками.

Каноническая ссылка: https://flashdata.dev/ru/docs/guides/response-formats
Разработчик: 2026-11-04 by 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. Он заменяет результаты; источник, статус и использование остаются доступными в виде полей 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/ru/docs/guides/headers-and-authentication/reference.md)
- [Реакционные поля Google Search](https://flashdata.dev/ru/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 | Квитанция о представлении | Игнорированный — выберите его при чтении результатов |
| POST /v1/queries/batch | Квитанция о представлении | Игнорированный — выберите его при чтении результатов |
| GET /v2/jobs/{id} | Статус работы | Игнорированный — нет контента результата |


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

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

Установите заголовки при чтении результата, даже если вы установили их при подаче. Установите JOB_ID на завершенную работу, к которой вы можете получить доступ. Этот GET считывает существующие результаты без отправки другого запроса.

| Запрашиваемый формат | Результативный ответ |
| --- | --- |
| Оригинал: JSON | 302 с подписанным хранилищем URL в Location. Выберите URL отдельно, без X-API-Key. Хранимые результаты могут быть сжаты gzip. |
| Простой текст или опция 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/ru/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: разметьте или опустите заголовок. Ценности, такие как json или text, не поддерживаются. |
| 406 · not_acceptable | Использование Accept: application/json или text/plain. text/markdown и application/xml не поддерживаются. |

- [Ошибки и коды состояния](https://flashdata.dev/ru/docs/errors/reference.md)

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

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

Отправьте Accept или отправьте */*, чтобы получить JSON. В ответах используется UTF-8. Поддерживаются диапазоны медиа и вес q; неподдерживаемый набор возвращает 406, если другой приемлемый диапазон не совпадает. Content-Type: application/json описывает тело запроса, а не ответ.

### Предпочитаете текст, разрешайте JSON

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

