curl --request POST \
--url https://api.octen.ai/pulse-search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"query": "wikipedia",
"count": 3
}
'{
"code": 0,
"msg": "success",
"request_id": "req_abc123def456",
"data": {
"query": "wikipedia",
"results": [
{
"title": "Wikipedia The Free Encyclopedia",
"url": "wikipedia.org"
},
{
"title": "Wikipedia, the free encyclopedia",
"url": "en.wikipedia.org/wiki/Main_Page"
},
{
"title": "Wikipedia",
"url": "en.wikipedia.org/wiki/Wikipedia"
}
]
},
"meta": {
"usage": {
"num_search_queries": 1,
"full_content_extra_count": 0,
"billed_mode": "lite"
},
"latency": 3,
"warning": ""
}
}Pulse Search API Reference
Generates the most likely URLs for a query in about 10ms and returns them in ranked order. Lite mode returns URLs and titles; standard mode adds highlights, full content, and images.
curl --request POST \
--url https://api.octen.ai/pulse-search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"query": "wikipedia",
"count": 3
}
'{
"code": 0,
"msg": "success",
"request_id": "req_abc123def456",
"data": {
"query": "wikipedia",
"results": [
{
"title": "Wikipedia The Free Encyclopedia",
"url": "wikipedia.org"
},
{
"title": "Wikipedia, the free encyclopedia",
"url": "en.wikipedia.org/wiki/Main_Page"
},
{
"title": "Wikipedia",
"url": "en.wikipedia.org/wiki/Wikipedia"
}
]
},
"meta": {
"usage": {
"num_search_queries": 1,
"full_content_extra_count": 0,
"billed_mode": "lite"
},
"latency": 3,
"warning": ""
}
}Authorizations
Bearer token used for request authentication. Alternatively, you can send the API key in the x-api-key header.
Body
The search query.
500Processing mode. lite returns the URL and title of each result. standard also returns highlights, full content, and images.
lite, standard Number of results to return.
1 <= x <= 10Controls highlight extraction from result pages. Has no effect in lite mode.
Show child attributes
Show child attributes
Controls whether to return the full raw content of each result page. Has no effect in lite mode.
Show child attributes
Show child attributes
Controls filtering of explicit/adult content. off disables filtering; strict drops all adult content.
off, strict Whether to include images in each result. Has no effect in lite mode.
Response
Successful pulse search response
Was this page helpful?