Execute Web Search
curl --request POST \
--url https://cloud.onyx.app/api/web-search/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"queries": [
"<string>"
],
"max_results": 10
}
'import requests
url = "https://cloud.onyx.app/api/web-search/search"
payload = {
"queries": ["<string>"],
"max_results": 10
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({queries: ['<string>'], max_results: 10})
};
fetch('https://cloud.onyx.app/api/web-search/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://cloud.onyx.app/api/web-search/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'queries' => [
'<string>'
],
'max_results' => 10
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://cloud.onyx.app/api/web-search/search"
payload := strings.NewReader("{\n \"queries\": [\n \"<string>\"\n ],\n \"max_results\": 10\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://cloud.onyx.app/api/web-search/search")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"queries\": [\n \"<string>\"\n ],\n \"max_results\": 10\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://cloud.onyx.app/api/web-search/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"queries\": [\n \"<string>\"\n ],\n \"max_results\": 10\n}"
response = http.request(request)
puts response.read_body{
"search_results": [
{
"document_citation_number": 123,
"url": "<string>",
"title": "<string>",
"snippet": "<string>",
"unique_identifier_to_strip_away": "<string>",
"type": "web_search"
}
],
"full_content_results": [
{
"document_citation_number": 123,
"content": "<string>",
"unique_identifier_to_strip_away": "<string>",
"type": "open_url"
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Search
Execute Web Search
Perform a web search and immediately fetch content for the returned URLs.
Use this when you want both snippets and page contents from one call.
If you want to selectively fetch content (i.e. let the LLM decide which URLs to read),
use /search-lite and then call /open-urls separately.
POST
/
web-search
/
search
Execute Web Search
curl --request POST \
--url https://cloud.onyx.app/api/web-search/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"queries": [
"<string>"
],
"max_results": 10
}
'import requests
url = "https://cloud.onyx.app/api/web-search/search"
payload = {
"queries": ["<string>"],
"max_results": 10
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({queries: ['<string>'], max_results: 10})
};
fetch('https://cloud.onyx.app/api/web-search/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://cloud.onyx.app/api/web-search/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'queries' => [
'<string>'
],
'max_results' => 10
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://cloud.onyx.app/api/web-search/search"
payload := strings.NewReader("{\n \"queries\": [\n \"<string>\"\n ],\n \"max_results\": 10\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://cloud.onyx.app/api/web-search/search")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"queries\": [\n \"<string>\"\n ],\n \"max_results\": 10\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://cloud.onyx.app/api/web-search/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"queries\": [\n \"<string>\"\n ],\n \"max_results\": 10\n}"
response = http.request(request)
puts response.read_body{
"search_results": [
{
"document_citation_number": 123,
"url": "<string>",
"title": "<string>",
"snippet": "<string>",
"unique_identifier_to_strip_away": "<string>",
"type": "web_search"
}
],
"full_content_results": [
{
"document_citation_number": 123,
"content": "<string>",
"unique_identifier_to_strip_away": "<string>",
"type": "open_url"
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Authorization header with Bearer token
Body
application/json
Response
Successful Response
Available options:
google_pse, serper, exa, searxng Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
onyx_web_crawler, firecrawl, exa ⌘I