curl --request POST \
--url https://api.olostep.com/v1/searches \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"query": "Best Answer Engine Optimization startups"
}
'
{
"id": "search_9bi0sbj9xa",
"object": "search",
"created": 1760327323,
"metadata": {},
"query": "Best Answer Engine Optimization startups",
"credits_consumed": 10,
"result": {
"json_content": "<string>",
"json_hosted_url": "<string>",
"links": [
{
"url": "<string>",
"title": "<string>",
"description": "<string>",
"markdown_content": "<string>",
"html_content": "<string>"
}
],
"size_exceeded": true,
"credits_consumed": 123
}
}搜索
创建搜索
使用自然语言查询搜索网络，并返回一个去重的相关链接列表，包含标题和描述。 它将在网络上语义搜索查询并返回结果。 可选地，传递 scrape_options 以抓取每个返回的 URL，并将 markdown_content / html_content 直接嵌入到每个链接中。页面抓取会通过底层的 /v1/scrapes 端点自动计费到你的团队。 参见 搜索功能。
POST
/
v1
/
searches
curl --request POST \
--url https://api.olostep.com/v1/searches \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"query": "Best Answer Engine Optimization startups"
}
'
{
"id": "search_9bi0sbj9xa",
"object": "search",
"created": 1760327323,
"metadata": {},
"query": "Best Answer Engine Optimization startups",
"credits_consumed": 10,
"result": {
"json_content": "<string>",
"json_hosted_url": "<string>",
"links": [
{
"url": "<string>",
"title": "<string>",
"description": "<string>",
"markdown_content": "<string>",
"html_content": "<string>"
}
],
"size_exceeded": true,
"credits_consumed": 123
}
}创建搜索
使用此端点来创建新的搜索请求。请求
路径POST /v1/searches
请求体
请求体必须是一个包含以下属性的 JSON 对象：
query(字符串): 要搜索的查询字符串。filters(对象): 可选的过滤器对象，用于限制搜索结果。sort(字符串): 可选的排序参数，定义结果的排序方式。
响应
成功的响应将返回一个包含搜索结果的 JSON 对象。示例
POST /v1/searches HTTP/1.1
Content-Type: application/json
{
"query": "Olostep",
"filters": {
"category": "technology"
},
"sort": "relevance"
}
响应示例
HTTP/1.1 200 OK
Content-Type: application/json
{
"results": [
{
"id": "123",
"title": "Olostep Technology Overview",
"snippet": "Learn more about Olostep's innovative technology solutions..."
}
],
"total": 1
}
错误
如果请求无效，服务器将返回一个错误响应。常见的错误包括：400 Bad Request: 请求体格式不正确或缺少必需的字段。401 Unauthorized: 缺少有效的身份验证凭据。500 Internal Server Error: 服务器遇到意外错误。
授权
Bearer认证头格式为Bearer ，其中是你的认证令牌。
请求体
application/json
自然语言的搜索查询。
示例:
"What's going on with OpenAI's Sora shutting down?"
去重后返回的最大链接数量。
必填范围:
1 <= x <= 25示例:
10
将结果限制在这些域名内。仅限裸主机——前导的 http(s):// 和尾部斜杠会自动去除。
示例:
["nytimes.com", "wsj.com"]
排除来自这些域名的结果。仅限裸主机——前导的 http(s):// 和尾部斜杠会自动去除。
示例:
["reddit.com"]
使用你的查询原文请求直接、低延迟的搜索。默认模式执行更广泛的搜索以覆盖更多结果。
可选。当提供时，每个返回的链接也会被抓取，其内容嵌入到响应中。每页抓取的费用会通过底层的 /v1/scrapes 端点自动计费。
Show child attributes
Show child attributes
此页面对您有帮助吗？