Перейти к содержимому
RU
Ключ API
Обзор документации

Справочник API

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

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

На этой странице

Выберите формат

JSON с исходными полями результатов - это по умолчанию. Accept выбирает JSON или простой текст; X-Respond-With: разметка преобразует содержимое результата в Markdown. Тело запроса остается JSON.

ОтветAcceptX-Respond-WithИспользовать для
JSONapplication/jsonОмитьПоля парсинга в коде · по умолчанию
JSON + Markdownapplication/jsonmarkdownАгентный контекст со структурированными метаданными
Простой текстtext/plainОмитьЧтение оригинальных полей в терминале
Текст + Markdowntext/plainmarkdownЧитать метаданные и Markdown вместе

Примеры запросов и ответов

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

По умолчанию. Проанализируйте массив результатов; поля внутри него зависят от источника.

Запрос · 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"}'
Пример ответа · иллюстративные значения
{
  "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"
}

Поддерживаемые конечные точки

Те же правила применяются к источникам запросов 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}Статус работыИгнорированный — нет контента результата

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

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

Запрашиваемый форматРезультативный ответ
Оригинал: JSON302 с подписанным хранилищем URL в Location. Выберите URL отдельно, без X-API-Key. Хранимые результаты могут быть сжаты gzip.
Простой текст или опция Markdown200 с отформатированным телом непосредственно в ответе.
Восстановление Markdown внутри 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'

Ошибки формата

Ошибки 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 не поддерживаются.

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

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

Предпочитаете текст, разрешайте JSON
Accept: text/plain; charset=utf-8, application/json;q=0.8