Felo API PlatformFelo API Platform
Все эндпоинты DataForSEO
v0.2.0-beta
OpenAPI 3.1.0

AI-сводка SERP API

Сервер:https://openapi.felo.ai
Клиентские библиотеки

DataForSEO

​

SEO, search-engine results, keyword research, backlinks and AI visibility data.

DataForSEO Операции

AI-сводка SERP API

​

Возвращает обзор AI, который Google показывает над результатами по запросу. Возвращает keyword, type, se_domain, location_code, language_code, check_url, datetime, spell, refinement_chips, item_types, items_count и items. Ответ обёрнут в конверт DataForSEO: данные в tasks[0].result, результат в tasks[0].status_code — отклонённый запрос всё равно возвращает HTTP 200.

Справочные цены

  • Тарификация: стоимость ответа по данным провайдера.
  • Справочная оценка запроса: USD 0.02.
  • Справочный множитель для клиента: 1.0. Не применяйте его повторно к уже рассчитанной сумме клиента.

Справочные метаданные, а не коммерческое предложение для аккаунта, гарантированная цена или лимит расходов. Кредиты ресурсов — не кредиты Felo. Итоговые списания определяются записями биллинга Felo.

Тело
application/json
  • Тип: array (object | null)[]
    • fetch_content
      Тип: boolean | null

      получать контент со страниц в SERP
      необязательное поле
      если задать true, API получит контент страниц, присутствующих в результатах SERP, и AI-модель учтёт этот контент при формировании сводки в результате;
      значение по умолчанию: false

    • include_links
      Тип: boolean | null

      включать ссылки на источники в сводку
      необязательное поле
      если задать true, поле summary в ответе API будет содержать ссылки на источники сформированной сводки;
      значение по умолчанию: false

    • prompt
      Тип: string | null

      AI-промпт
      необязательное поле
      дополнительная задача для AI-суммаризатора;
      любой текст, вопрос или информация, сообщающие AI, какой ответ вам нужен;
      максимальное число символов: 2000;
      примечание: промпт должен соответствовать ключевому слову, указанному в POST-запросе к SERP API

    • support_extra
      Тип: boolean | null

      поддержка дополнительных функций SERP
      необязательное поле
      если задать true, AI-модель учтёт следующие дополнительные функции SERP помимо результатов organic: answer_box, knowledge_graph, featured_snippet;
      значение по умолчанию: true

    • task_id
      Тип: string

      идентификатор задачи
      обязательное поле
      уникальный идентификатор связанной задачи в формате UUID
      в течение 30 дней вы сможете в любой момент запросить по нему результаты задачи

Ответы
  • 200
    Тип: object | null · Response36Afe1097B20_SerpAiSummaryResponseInfo
    • cost
      Тип: number | null Формат: double

      общая стоимость задач, USD

    • status_code
      Тип: integer | null

      общий код состояния. Полный список кодов ответа можно найти здесь.

    • status_message
      Тип: string | null

      общее информационное сообщение. Полный список общих информационных сообщений можно найти здесь.

    • tasks
      Тип: array (object | null)[] | null

      массив задач

      • Тип: object | null · Response36Afe1097B20_SerpAiSummaryTaskInfo
        • cost
          Тип: number | null Формат: double

          общая стоимость задач, USD

        • data
          Тип: object | null

          содержит те же параметры, что вы указали в POST-запросе

          • propertyName
            Тип: object | null
        • id
          Тип: string | null

          идентификатор задачи уникальный идентификатор задачи в нашей системе в формате UUID

        • path
          Тип: array (string | null)[] | null

          путь URL

        • result
          Тип: array (object | null)[] | null

          массив результатов

          • items
            Тип: array (object | null)[] | null

            массив элементов

            • summary
              Тип: string | null

              сгенерированная сводка
              сводка, сгенерированная AI-моделью согласно параметрам, указанным в запросе

          • items_count
            Тип: integer | null Формат: int64

            количество элементов в массиве результатов

        • result_count
          Тип: integer | null Формат: int64

          число элементов в массиве result

        • status_code
          Тип: integer | null

          код состояния задачи формируется DataForSEO, может находиться в диапазоне 10000-60000 Полный список кодов ответа можно найти здесь.

        • status_message
          Тип: string | null

          информационное сообщение задачи Полный список общих информационных сообщений можно найти здесь.

        • time
          Тип: string | null

          время выполнения, секунды

    • tasks_count
      Тип: integer | null Формат: int64

      число задач в массиве tasks

    • tasks_error
      Тип: integer | null Формат: int64

      число задач в массиве tasks, возвращённых с ошибкой

    • time
      Тип: string | null

      общее время выполнения, секунды

    • version
      Тип: string | null

      текущая версия API

    application/json
  • 400

    Запрос не удалось обработать. Проверьте параметры запроса.

  • 401

    Требуется действительный API-ключ Felo.

  • 402

    Запрос не может быть выполнен: не выполнено требование биллинга.

  • 403

    Аккаунту не разрешено выполнять эту операцию.

  • 429

    Достигнут лимит запросов или расходов.

  • 502

    Сервис не смог выполнить запрос.

  • 503

    API или сервис биллинга временно недоступны.

  • 504

    Истекло время ожидания обработки запроса.

  • default

    Ответ с ошибкой; сквозные ответы upstream могут использовать форматы провайдера

    application/json
Request Example for post/v1/beta/dataforseo/serp/ai_summary
curl https://openapi.felo.ai/v1/beta/dataforseo/serp/ai_summary \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "task_id": "07031739-1535-0139-0000-9d1e639a5b7d",
    "prompt": "explain what DataForSEO is",
    "include_links": true,
    "fetch_content": true
  }
]'
{
  "version": null,
  "status_code": null,
  "status_message": null,
  "time": null,
  "cost": null,
  "tasks_count": null,
  "tasks_error": null,
  "tasks": [
    {
      "id": null,
      "status_code": null,
      "status_message": null,
      "time": null,
      "cost": null,
      "result_count": null,
      "path": [
        null
      ],
      "data": null,
      "result": [
        {
          "items_count": null,
          "items": [
            {
              "summary": null
            }
          ]
        }
      ]
    }
  ]
}
SERP API AI Summary

Нужна помощь?