Felo API PlatformFelo API Platform

データ API / BytePlus / Web Search

AI-oriented real-time web search.

Run a real-time web search built for AI agents and return a ranked list of titled results with links and snippets. Query is required; narrow the result set with Count (≤ 20), Filter (restrict to Sites or exclude BlockHosts), Language, and TimeRange. The response wraps ResponseMetadata.RequestId and a Result list of web results. Use it for RAG retrieval augmentation, competitive/PR monitoring, fact-checking, and content sourcing; pair each result URL with post_byteplus_fetch to pull full page content.

パラメータ

パス・クエリ・ヘッダーのパラメータはありません。

リクエストボディ

  • Querystring必須

    The search query. Required. Max 400 characters; the upstream engine also effectively caps around 50 words.

  • Countinteger任意

    Number of results to return. Optional; default 10, maximum 20.

  • Filterobject任意

    Optional result filter. Both fields are pipe-separated strings of full domains (max 5 each).

  • Sitesstring任意

    Restrict results to these full domains. Pipe-separated, max 5, e.g. "bytedance.com|byteplus.com". (Sending an array returns 10400 Invalid Parameter.)

  • BlockHostsstring任意

    Exclude results from these full domains. Pipe-separated, max 5, e.g. "reddit.com|quora.com".

  • Languagestring任意

    Optional language hint in the upstream format, e.g. EN, ZH-HANS, ZH-HANT.

  • TimeRange任意

    指定できる値： OneDay · OneWeek · OneMonth · OneYear

    Optional recency window. One of the named windows OneDay / OneWeek / OneMonth / OneYear, or a custom range "YYYY-MM-DD..YYYY-MM-DD". Omit for no time filter. NOTE: values like "week"/"month" are silently ignored upstream.

リクエスト例

curl -X POST "https://openapi.felo.ai/v1/beta/byteplus/web-search" \
  -H "Authorization: Bearer $FELO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "Query": "<string>",
  "Count": 0,
  "Filter": {},
  "Language": "<string>",
  "TimeRange": {}
}'

レスポンス

レスポンスのフィールド

  • ResponseMetadataobject任意

    Upstream request metadata.

  • RequestIdstring任意

    Unique identifier for this request.

  • Actionstring任意
  • Versionstring任意
  • Servicestring任意
  • Regionstring任意
  • Resultobject任意

    Search result payload.

  • ResultCountinteger任意

    Number of web results returned.

  • WebResultsobject[]任意

    Ranked list of web results.

  • Idstring任意

    Opaque result id.

  • SortIdinteger任意

    1-based rank of the result.

  • Titlestring任意

    Result title.

  • SiteNamestring任意

    Source site name (may be empty).

  • Urlstring任意

    Result URL.

  • Snippetstring任意

    Short text snippet from the page.

  • Summarystring任意

    Longer summary of the page content.

  • PublishTimestring任意

    Publish time in ISO 8601 (may be empty).

  • PublishTimeUnixinteger任意

    Publish time as Unix seconds (0 if unknown).

  • LogoUrlstring任意

    Signed site logo URL (time-limited).

  • SearchContextobject任意

    Echo of the resolved query context.

  • OriginQuerystring任意
  • SearchTypestring任意
  • TimeCostinteger任意

    Upstream processing time in milliseconds.

  • LogIdstring任意

    Upstream log id (equals ResponseMetadata.RequestId).

  • Choices任意

    Reserved; null unless applicable.

  • Usage任意

    Reserved; null unless applicable.