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.