Перейти до вмісту
UK
Отримати ключ API
Переглянути документацію

Довідник API

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

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

На цій сторінці

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

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При отриманні дозволівIgnored — вибрати його при результатах читання
POST /v1/queries/batchПри отриманні дозволівIgnored — вибрати його при результатах читання
GET /v2/jobs/{id}Статус на сервериIgnored — немає вмісту результату тут

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

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

Заявка на форматВідповідність результатів
Оригінальний JSON302 з підписаним сховищем URL в Місцезнаходження. Кишеня, що URL окремо, без X-API-Key. Зберігати результати можна за допомогою gzip-compressed.
Плайн текст або параметр 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: розмітка або омикання заголовка. Значення, такі як джсон або текст не підтримується.
406 · not_acceptableВикористовуйте Accept: application/json або text/plain. text/markdown і application/xml не підтримуються.

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

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

Зашифрувати текст, дозволити JSON
Accept: text/plain; charset=utf-8, application/json;q=0.8