BytePlus
Web search and page content retrieval.
جستجوی وب بلادرنگ مناسب AI.
اجرای جستجوی وب بلادرنگ ساخته‌شده برای عامل‌های AI و بازگرداندن فهرست رتبه‌بندی‌شده نتایج دارای عنوان با پیوندها و قطعه‌ها. Query الزامی است؛ مجموعه نتایج را با Count (≤ 20)، Filter (محدود کردن به Sites یا حذف BlockHosts)، Language و TimeRange محدود کنید. پاسخ ResponseMetadata.RequestId و فهرست Result از نتایج وب را دربر می‌گیرد. از آن برای افزایش بازیابی RAG، پایش رقبا و روابط عمومی، راستی‌آزمایی و تأمین محتوا استفاده کنید؛ هر URL نتیجه را با post_byteplus_fetch جفت کنید تا محتوای کامل صفحه را بگیرید.
مرجع قیمت‌گذاری
- اندازه‌گیری: مبنای هزینه ثابت برای درخواست موفق.
- برآورد درخواست مرجع: 0.0048 دلار آمریکا.
- ضریب مشتری مرجع: 1.0. ضریب‌های مرجع را نباید دوباره روی مبالغ تسویه‌شده مشتری اعمال کرد.
فقط فراداده مرجع، نه نقل‌قول حساب، نه قیمت تضمین‌شده و نه سقف هزینه. اعتبار منابع، اعتبار Felo نیست. هزینه‌های نهایی تابع سوابق صورت‌حساب Felo است.
- نوع: stringQueryحداکثر طول:400الزامی
کوئری جستجو. الزامی. حداکثر 400 نویسه؛ موتور بالادست نیز عملاً حدود 50 واژه را محدود می‌کند.
- نوع: integerCountحداکثر:20
تعداد نتایج برای بازگرداندن. اختیاری؛ پیش‌فرض 10، حداکثر 20.
- نوع: objectFilter
فیلتر نتایج اختیاری. هر دو فیلد رشته‌هایی از دامنه‌های کامل هستند که با نویسه | جدا شده‌اند (حداکثر 5 در هر کدام).
- Blockنوع: string
Hosts نتایج این دامنه‌های کامل را حذف کنید. جداشده با |، حداکثر 5، مثلاً "reddit.com|quora.com".
- Sitesنوع: string
نتایج را به این دامنه‌های کامل محدود کنید. جداشده با |، حداکثر 5، مثلاً "bytedance.com|byteplus.com". (ارسال آرایه 10400 Invalid Parameter برمی‌گرداند.)
- نوع: stringLanguage
راهنمای زبان اختیاری در قالب بالادست، مثلاً EN، ZH-HANS، ZH-HANT.
- Time
Range بازه زمانی اختیاری برای تازگی. یکی از بازه‌های نام‌دار OneDay / OneWeek / OneMonth / OneYear، یا بازه سفارشی "YYYY-MM-DD..YYYY-MM-DD". برای نبود فیلتر زمانی آن را حذف کنید. توجه: مقادیری مانند "week"/"month" در بالادست بی‌صدا نادیده گرفته می‌شوند.
- نوع: string فهرست مقادیر
بازه زمانی اختیاری برای تازگی. یکی از بازه‌های نام‌دار OneDay / OneWeek / OneMonth / OneYear، یا بازه سفارشی "YYYY-MM-DD..YYYY-MM-DD". برای نبود فیلتر زمانی آن را حذف کنید. توجه: مقادیری مانند "week"/"month" در بالادست بی‌صدا نادیده گرفته می‌شوند.
مقادیر- One
Day - One
Week - One
Month - One
Year
- نوع: object200
جستجو با موفقیت انجام شد.
Resultنتایج رتبه‌بندی‌شده وب را نگه می‌دارد.- نوع: objectResponse
Metadata فراداده درخواست بالادست.
- Actionنوع: string
- Regionنوع: string
- Requestنوع: string
Id شناسه یکتای این درخواست.
- Serviceنوع: string
- Versionنوع: string
- نوع: objectResult
محتوای نتیجه جستجو.
- Choicesنوع: array object[] | null
رزروشده؛ null مگر آنکه کاربرد داشته باشد.
شیء خالی - Logنوع: string
Id شناسه لاگ بالادست (برابر با ResponseMetadata.RequestId).
- Resultنوع: integer
Count تعداد نتایج وب بازگردانده‌شده.
- Searchنوع: object
Context بازتاب زمینه کوئری حل‌شده.
- Originنوع: string
Query - Searchنوع: string
Type
- Timeنوع: integer
Cost زمان پردازش بالادست بر حسب میلی‌ثانیه.
- Usageنوع: object | null
رزروشده؛ null مگر آنکه کاربرد داشته باشد.
- Webنوع: array object[]
Results فهرست رتبه‌بندی‌شده نتایج وب.
- Idنوع: string
شناسه مبهم نتیجه.
- Logoنوع: string
Url نشانی URL امضاشده لوگوی سایت (محدود به زمان).
- Publishنوع: string
Time زمان انتشار در ISO 8601 (ممکن است خالی باشد).
- Publishنوع: integer
Time Unix زمان انتشار به ثانیه یونیکس (0 اگر نامشخص باشد).
- Siteنوع: string
Name نام سایت منبع (ممکن است خالی باشد).
- Snippetنوع: string
قطعه متن کوتاه از صفحه.
- Sortنوع: integer
Id رتبه نتیجه با شروع از 1.
- Summaryنوع: string
خلاصه بلندتر از محتوای صفحه.
- Titleنوع: string
عنوان نتیجه.
- Urlنوع: string
نشانی URL نتیجه.
application/json - 400
درخواست پردازش نشد. پارامترهای درخواست را بررسی کنید.
- 401
یک کلید API معتبر Felo لازم است.
- 402
درخواست ادامه نمی‌یابد چون یک الزام صورت‌حساب برآورده نشده است.
- 403
حساب مجاز به انجام این عملیات نیست.
- 429
به سقف درخواست یا هزینه رسیده‌اید.
- 502
سرویس نتوانست درخواست را کامل کند.
- 503
سرویس API یا صورت‌حساب موقتاً در دسترس نیست.
- 504
سرویس هنگام پردازش درخواست به پایان مهلت رسید.
- default
پاسخ خطا؛ پاسخ‌های عبوری بالادست ممکن است از قالب‌های ارائه‌دهنده استفاده کنند
application/json
curl https://openapi.felo.ai/v1/beta/byteplus/web-search \
--request POST \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--data '{
"Query": "OpenAI news"
}'
{
"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
}
}