# Вебпошук у реальному часі для AI.

**API:** Data API

**Endpoint:** `POST /v1/beta/byteplus/web-search`

**Tags:** BytePlus

Виконує вебпошук у реальному часі, створений для AI-агентів, і повертає ранжований список результатів із заголовками, посиланнями та фрагментами. `Query` обов'язковий; звузьте набір результатів за допомогою `Count` (≤ 20), `Filter` (обмежити `Sites` або виключити `BlockHosts`), `Language` і `TimeRange`. Відповідь обгортає `ResponseMetadata.RequestId` і список `Result` з вебрезультатами. Використовуйте для доповнення RAG-вибірки, моніторингу конкурентів/PR, перевірки фактів і пошуку джерел вмісту; кожен URL результату передавайте в `post_byteplus_fetch`, щоб отримати повний вміст сторінки.

### Довідкові дані про ціни

- Тарифікація: фіксована базова вартість успішного запиту.
- Орієнтовна вартість запиту: USD 0.0048.
- Довідковий множник для клієнта: 1.0. Не застосовуйте його повторно до вже розрахованої суми клієнта.

Довідкові метадані, а не котирування для облікового запису, гарантована ціна чи ліміт витрат. Кредити ресурсів — це не кредити Felo. Остаточні списання здійснюються за записами білінгу Felo.

## Base URL

- `https://openapi.felo.ai`

## Authentication

- `FeloBearerAuth` (http bearer, bearer format Felo API Key)
- `FeloApiKey` (apiKey in header `X-API-Key`)

## Request body

Required: **yes**

### application/json

Schema:

```json
{
  "type": "object",
  "properties": {
    "Query": {
      "type": "string",
      "description": "Пошуковий запит. Обов'язково. Максимум 400 символів; движок upstream також фактично обмежує приблизно 50 словами.",
      "example": "OpenAI news",
      "maxLength": 400
    },
    "Count": {
      "type": "integer",
      "description": "Кількість результатів для повернення. Необов'язково; за замовчуванням 10, максимум 20.",
      "maximum": 20,
      "example": 10,
      "default": 10
    },
    "Filter": {
      "type": "object",
      "description": "Необов'язковий фільтр результатів. Обидва поля — рядки повних доменів через вертикальну риску (не більше 5 у кожному).",
      "properties": {
        "Sites": {
          "type": "string",
          "description": "Обмежити результати цими повними доменами. Через вертикальну риску, максимум 5, наприклад \"bytedance.com|byteplus.com\". (Передавання масиву повертає 10400 Invalid Parameter.)",
          "example": "bytedance.com|byteplus.com"
        },
        "BlockHosts": {
          "type": "string",
          "description": "Виключити результати з цих повних доменів. Через вертикальну риску, максимум 5, наприклад \"reddit.com|quora.com\".",
          "example": "reddit.com|quora.com"
        }
      }
    },
    "Language": {
      "type": "string",
      "description": "Необов'язкова підказка мови у форматі upstream, наприклад EN, ZH-HANS, ZH-HANT.",
      "example": "EN"
    },
    "TimeRange": {
      "description": "Необов'язкове вікно свіжості. Одне з іменованих вікон OneDay / OneWeek / OneMonth / OneYear або користувацький діапазон \"YYYY-MM-DD..YYYY-MM-DD\". Не вказуйте, щоб не фільтрувати за часом. ПРИМІТКА: значення на кшталт \"week\"/\"month\" upstream мовчки ігнорує.",
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "OneDay",
            "OneWeek",
            "OneMonth",
            "OneYear"
          ]
        },
        {
          "type": "string",
          "pattern": "^\\d{4}-\\d{2}-\\d{2}\\.\\.\\d{4}-\\d{2}-\\d{2}$",
          "description": "Користувацький діапазон, наприклад 2026-08-01..2026-09-01."
        }
      ],
      "example": "OneWeek"
    }
  },
  "required": [
    "Query"
  ]
}
```

Example:

```json
{
  "Query": "OpenAI news"
}
```

## Responses

### 200 — Пошук успішно завершено. `Result` містить ранжовані вебрезультати.

Headers:
- `X-Request-Id` (string) — Ідентифікатор запиту, який потрібно вказати під час звернення до підтримки Felo.

**application/json**

Schema: object

```json
{
  "type": "object",
  "properties": {
    "ResponseMetadata": {
      "type": "object",
      "description": "Метадані запиту upstream.",
      "properties": {
        "RequestId": {
          "type": "string",
          "description": "Унікальний ідентифікатор цього запиту."
        },
        "Action": {
          "type": "string"
        },
        "Version": {
          "type": "string"
        },
        "Service": {
          "type": "string"
        },
        "Region": {
          "type": "string"
        }
      }
    },
    "Result": {
      "type": "object",
      "description": "Корисне навантаження результатів пошуку.",
      "properties": {
        "ResultCount": {
          "type": "integer",
          "description": "Кількість повернутих веб-результатів."
        },
        "WebResults": {
          "type": "array",
          "description": "Ранжований список веб-результатів.",
          "items": {
            "type": "object",
            "properties": {
              "Id": {
                "type": "string",
                "description": "Непрозорий id результату."
              },
              "SortId": {
                "type": "integer",
                "description": "Ранг результату, починаючи з 1."
              },
              "Title": {
                "type": "string",
                "description": "Заголовок результату."
              },
              "SiteName": {
                "type": "string",
                "description": "Назва сайту-джерела (може бути порожньою)."
              },
              "Url": {
                "type": "string",
                "description": "URL результату."
              },
              "Snippet": {
                "type": "string",
                "description": "Короткий фрагмент тексту зі сторінки."
              },
              "Summary": {
                "type": "string",
                "description": "Довша зведена інформація про вміст сторінки."
              },
              "PublishTime": {
                "type": "string",
                "description": "Час публікації в ISO 8601 (може бути порожнім)."
              },
              "PublishTimeUnix": {
                "type": "integer",
                "description": "Час публікації в секундах Unix (0, якщо невідомо)."
              },
              "LogoUrl": {
                "type": "string",
                "description": "Підписаний URL логотипа сайту (обмежений у часі)."
              }
            }
          }
        },
        "SearchContext": {
          "type": "object",
          "description": "Копія визначеного контексту запиту.",
          "properties": {
            "OriginQuery": {
              "type": "string"
            },
            "SearchType": {
              "type": "string"
            }
          }
        },
        "TimeCost": {
          "type": "integer",
          "description": "Час обробки upstream у мілісекундах."
        },
        "LogId": {
          "type": "string",
          "description": "ID журналу upstream (дорівнює ResponseMetadata.RequestId)."
        },
        "Choices": {
          "type": [
            "array",
            "null"
          ],
          "description": "Зарезервовано; null, якщо не застосовується.",
          "items": {
            "type": "object"
          }
        },
        "Usage": {
          "type": [
            "object",
            "null"
          ],
          "description": "Зарезервовано; null, якщо не застосовується."
        }
      }
    }
  }
}
```

Example:

```json
{
  "ResponseMetadata": {
    "RequestId": "20260904155503A787EC832774768DC56F",
    "Action": "",
    "Version": "",
    "Service": "",
    "Region": ""
  },
  "Result": {
    "ResultCount": 3,
    "WebResults": [
      {
        "Id": "19b903d59c017bbb04c7832574500d49",
        "SortId": 1,
        "Title": "OpenAI News | OpenAI",
        "SiteName": "OpenAI",
        "Url": "https://openai.com/news/",
        "Snippet": "Stay up to speed on the rapid advancement of AI technology and the benefits it offers to humanity.",
        "Summary": "Stay up to speed on the rapid advancement of AI technology and the benefits it offers to humanity.",
        "PublishTime": "2026-09-03T07:50:20+08:00",
        "PublishTimeUnix": 1788393020,
        "LogoUrl": "https://p16-bpsearch-sign.ibyteimg.com/...<signed>"
      }
    ],
    "SearchContext": {
      "OriginQuery": "OpenAI latest news",
      "SearchType": "web"
    },
    "TimeCost": 935,
    "LogId": "20260904155503A787EC832774768DC56F",
    "Choices": null,
    "Usage": null
  }
}
```

### 400 — Не вдалося обробити запит. Перевірте параметри запиту.

### 401 — Потрібен дійсний API-ключ Felo.

### 402 — Запит неможливо виконати: умови білінгу не виконано.

### 403 — Обліковий запис не має дозволу на цю операцію.

### 429 — Досягнуто ліміту запитів або витрат.

### 502 — Служба не змогла виконати запит.

### 503 — API або служба білінгу тимчасово недоступні.

### 504 — Час очікування обробки запиту вичерпано.

### default — Відповідь із помилкою; наскрізні відповіді апстріму можуть використовувати формати постачальника

**application/json**

Schema:

```json
{}
```
