web.search

POST

ops

web.search

Web or news search across several engines. Returns a normalized result page.

curl --request POST \
  --url https://api.agentkey.app/v2/ops/web.search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "country": "<string>",
  "cursor": "<string>",
  "exclude_domains": [
    "<string>"
  ],
  "fields": [
    "<string>"
  ],
  "include_domains": [
    "<string>"
  ],
  "include_raw": false,
  "lang": "<string>",
  "limit": 10,
  "provider": "<string>",
  "routing": {
    "allow_fallbacks": true,
    "only": [
      "<string>"
    ],
    "order": [
      "<string>"
    ],
    "strategy": "auto"
  },
  "time_range": "all",
  "type": "web"
}
'

import requests

url = "https://api.agentkey.app/v2/ops/web.search"

payload = {
    "query": "<string>",
    "country": "<string>",
    "cursor": "<string>",
    "exclude_domains": ["<string>"],
    "fields": ["<string>"],
    "include_domains": ["<string>"],
    "include_raw": False,
    "lang": "<string>",
    "limit": 10,
    "provider": "<string>",
    "routing": {
        "allow_fallbacks": True,
        "only": ["<string>"],
        "order": ["<string>"],
        "strategy": "auto"
    },
    "time_range": "all",
    "type": "web"
}
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({
    query: '<string>',
    country: '<string>',
    cursor: '<string>',
    exclude_domains: ['<string>'],
    fields: ['<string>'],
    include_domains: ['<string>'],
    include_raw: false,
    lang: '<string>',
    limit: 10,
    provider: '<string>',
    routing: {
      allow_fallbacks: true,
      only: ['<string>'],
      order: ['<string>'],
      strategy: 'auto'
    },
    time_range: 'all',
    type: 'web'
  })
};

fetch('https://api.agentkey.app/v2/ops/web.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://api.agentkey.app/v2/ops/web.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([
    'query' => '<string>',
    'country' => '<string>',
    'cursor' => '<string>',
    'exclude_domains' => [
        '<string>'
    ],
    'fields' => [
        '<string>'
    ],
    'include_domains' => [
        '<string>'
    ],
    'include_raw' => false,
    'lang' => '<string>',
    'limit' => 10,
    'provider' => '<string>',
    'routing' => [
        'allow_fallbacks' => true,
        'only' => [
                '<string>'
        ],
        'order' => [
                '<string>'
        ],
        'strategy' => 'auto'
    ],
    'time_range' => 'all',
    'type' => 'web'
  ]),
  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://api.agentkey.app/v2/ops/web.search"

	payload := strings.NewReader("{\n  \"query\": \"<string>\",\n  \"country\": \"<string>\",\n  \"cursor\": \"<string>\",\n  \"exclude_domains\": [\n    \"<string>\"\n  ],\n  \"fields\": [\n    \"<string>\"\n  ],\n  \"include_domains\": [\n    \"<string>\"\n  ],\n  \"include_raw\": false,\n  \"lang\": \"<string>\",\n  \"limit\": 10,\n  \"provider\": \"<string>\",\n  \"routing\": {\n    \"allow_fallbacks\": true,\n    \"only\": [\n      \"<string>\"\n    ],\n    \"order\": [\n      \"<string>\"\n    ],\n    \"strategy\": \"auto\"\n  },\n  \"time_range\": \"all\",\n  \"type\": \"web\"\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://api.agentkey.app/v2/ops/web.search")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"query\": \"<string>\",\n  \"country\": \"<string>\",\n  \"cursor\": \"<string>\",\n  \"exclude_domains\": [\n    \"<string>\"\n  ],\n  \"fields\": [\n    \"<string>\"\n  ],\n  \"include_domains\": [\n    \"<string>\"\n  ],\n  \"include_raw\": false,\n  \"lang\": \"<string>\",\n  \"limit\": 10,\n  \"provider\": \"<string>\",\n  \"routing\": {\n    \"allow_fallbacks\": true,\n    \"only\": [\n      \"<string>\"\n    ],\n    \"order\": [\n      \"<string>\"\n    ],\n    \"strategy\": \"auto\"\n  },\n  \"time_range\": \"all\",\n  \"type\": \"web\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.agentkey.app/v2/ops/web.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  \"query\": \"<string>\",\n  \"country\": \"<string>\",\n  \"cursor\": \"<string>\",\n  \"exclude_domains\": [\n    \"<string>\"\n  ],\n  \"fields\": [\n    \"<string>\"\n  ],\n  \"include_domains\": [\n    \"<string>\"\n  ],\n  \"include_raw\": false,\n  \"lang\": \"<string>\",\n  \"limit\": 10,\n  \"provider\": \"<string>\",\n  \"routing\": {\n    \"allow_fallbacks\": true,\n    \"only\": [\n      \"<string>\"\n    ],\n    \"order\": [\n      \"<string>\"\n    ],\n    \"strategy\": \"auto\"\n  },\n  \"time_range\": \"all\",\n  \"type\": \"web\"\n}"

response = http.request(request)
puts response.read_body

{
  "attempts": [
    {
      "provider": "<string>",
      "status": 123,
      "took_ms": 123,
      "tool": "<string>",
      "error_type": "<string>",
      "refunded": true,
      "upstream_status": 123
    }
  ],
  "credits_charged": 123,
  "data": {
    "items": [
      {
        "published_at": "2023-11-07T05:31:56Z",
        "site": "<string>",
        "snippet": "<string>",
        "title": "<string>",
        "url": "<string>"
      }
    ],
    "next_cursor": "<string>"
  },
  "op": "<string>",
  "op_version": 123,
  "provider": "<string>",
  "request_id": "<string>",
  "took_ms": 123,
  "unsupported_fields": [
    "<string>"
  ],
  "raw": "<unknown>",
  "raw_truncated": true
}

{
  "code": 123,
  "error": "<string>",
  "error_type": "<string>",
  "attempts": [
    {
      "provider": "<string>",
      "status": 123,
      "took_ms": 123,
      "tool": "<string>",
      "error_type": "<string>",
      "refunded": true,
      "upstream_status": 123
    }
  ],
  "op": "<string>",
  "request_id": "<string>"
}

{
  "code": 123,
  "error": "<string>",
  "error_type": "<string>",
  "attempts": [
    {
      "provider": "<string>",
      "status": 123,
      "took_ms": 123,
      "tool": "<string>",
      "error_type": "<string>",
      "refunded": true,
      "upstream_status": 123
    }
  ],
  "op": "<string>",
  "request_id": "<string>"
}

{
  "code": 123,
  "error": "<string>",
  "error_type": "<string>",
  "attempts": [
    {
      "provider": "<string>",
      "status": 123,
      "took_ms": 123,
      "tool": "<string>",
      "error_type": "<string>",
      "refunded": true,
      "upstream_status": 123
    }
  ],
  "op": "<string>",
  "request_id": "<string>"
}

{
  "code": 123,
  "error": "<string>",
  "error_type": "<string>",
  "attempts": [
    {
      "provider": "<string>",
      "status": 123,
      "took_ms": 123,
      "tool": "<string>",
      "error_type": "<string>",
      "refunded": true,
      "upstream_status": 123
    }
  ],
  "op": "<string>",
  "request_id": "<string>"
}

{
  "code": 123,
  "error": "<string>",
  "error_type": "<string>",
  "attempts": [
    {
      "provider": "<string>",
      "status": 123,
      "took_ms": 123,
      "tool": "<string>",
      "error_type": "<string>",
      "refunded": true,
      "upstream_status": 123
    }
  ],
  "op": "<string>",
  "request_id": "<string>"
}

{
  "code": 123,
  "error": "<string>",
  "error_type": "<string>",
  "attempts": [
    {
      "provider": "<string>",
      "status": 123,
      "took_ms": 123,
      "tool": "<string>",
      "error_type": "<string>",
      "refunded": true,
      "upstream_status": 123
    }
  ],
  "op": "<string>",
  "request_id": "<string>"
}

Authorizations

Authorization

string

header

required

AgentKey API key (ak_…).

Body

application/json

query

string

required

Search query.

country

string

ISO 3166-1 alpha-2 country code to bias results, e.g. US, CN.

cursor

string

Opaque pagination cursor from the previous response's next_cursor. Send the same query parameters with it.

exclude_domains

string[]

Exclude results from these domains (routes to an engine that supports it).

fields

string[]

Projection: keep only these dotted paths of data, e.g. ["items.id", "items.text"].

include_domains

string[]

Restrict results to these domains (routes to an engine that supports it).

include_raw

boolean

default:false

Attach the raw upstream payload as raw (not a stable contract; truncated above 256 KB).

lang

string

BCP 47 language tag for the results language, e.g. en, zh-Hans.

limit

integer

default:10

Maximum number of results to return.

Required range: 1 <= x <= 20

provider

string

Shorthand for routing.only = [provider].

routing

object

Provider routing override. order: try these providers first; only: restrict to these (equivalent to pinning); allow_fallbacks: false tries only the first eligible provider.

Show child attributes

time_range

enum<string>

default:all

Only results published within this window.

Available options:

day,

week,

month,

year,

all

type

enum<string>

default:web

Result type. images and videos are planned as non-breaking additions.

Available options:

web,

news

Response

Success envelope

Success envelope whose data is a WebResultPage.

attempts

object[]

required

Show child attributes

credits_charged

number

required

Credits charged for this call (the method's fixed price).

data

object

required

One page of web search results.

Show child attributes

string

required

Method name.

op_version

integer

required

Method version that served the call.

provider

string

required

Provider that actually served the call.

request_id

string

required

Correlation id; quote it in support requests.

took_ms

integer

required

unsupported_fields

string[]

required

Output paths this provider structurally does not supply; such fields are null for a different reason than 'missing on this record'.

raw

any

Upstream payload, only with include_raw=true. Not a stable contract.

raw_truncated

boolean

Web or news search across several engines. Returns a normalized result page.

curl --request POST \
  --url https://api.agentkey.app/v2/ops/web.search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "country": "<string>",
  "cursor": "<string>",
  "exclude_domains": [
    "<string>"
  ],
  "fields": [
    "<string>"
  ],
  "include_domains": [
    "<string>"
  ],
  "include_raw": false,
  "lang": "<string>",
  "limit": 10,
  "provider": "<string>",
  "routing": {
    "allow_fallbacks": true,
    "only": [
      "<string>"
    ],
    "order": [
      "<string>"
    ],
    "strategy": "auto"
  },
  "time_range": "all",
  "type": "web"
}
'

import requests

url = "https://api.agentkey.app/v2/ops/web.search"

payload = {
    "query": "<string>",
    "country": "<string>",
    "cursor": "<string>",
    "exclude_domains": ["<string>"],
    "fields": ["<string>"],
    "include_domains": ["<string>"],
    "include_raw": False,
    "lang": "<string>",
    "limit": 10,
    "provider": "<string>",
    "routing": {
        "allow_fallbacks": True,
        "only": ["<string>"],
        "order": ["<string>"],
        "strategy": "auto"
    },
    "time_range": "all",
    "type": "web"
}
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({
    query: '<string>',
    country: '<string>',
    cursor: '<string>',
    exclude_domains: ['<string>'],
    fields: ['<string>'],
    include_domains: ['<string>'],
    include_raw: false,
    lang: '<string>',
    limit: 10,
    provider: '<string>',
    routing: {
      allow_fallbacks: true,
      only: ['<string>'],
      order: ['<string>'],
      strategy: 'auto'
    },
    time_range: 'all',
    type: 'web'
  })
};

fetch('https://api.agentkey.app/v2/ops/web.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://api.agentkey.app/v2/ops/web.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([
    'query' => '<string>',
    'country' => '<string>',
    'cursor' => '<string>',
    'exclude_domains' => [
        '<string>'
    ],
    'fields' => [
        '<string>'
    ],
    'include_domains' => [
        '<string>'
    ],
    'include_raw' => false,
    'lang' => '<string>',
    'limit' => 10,
    'provider' => '<string>',
    'routing' => [
        'allow_fallbacks' => true,
        'only' => [
                '<string>'
        ],
        'order' => [
                '<string>'
        ],
        'strategy' => 'auto'
    ],
    'time_range' => 'all',
    'type' => 'web'
  ]),
  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://api.agentkey.app/v2/ops/web.search"

	payload := strings.NewReader("{\n  \"query\": \"<string>\",\n  \"country\": \"<string>\",\n  \"cursor\": \"<string>\",\n  \"exclude_domains\": [\n    \"<string>\"\n  ],\n  \"fields\": [\n    \"<string>\"\n  ],\n  \"include_domains\": [\n    \"<string>\"\n  ],\n  \"include_raw\": false,\n  \"lang\": \"<string>\",\n  \"limit\": 10,\n  \"provider\": \"<string>\",\n  \"routing\": {\n    \"allow_fallbacks\": true,\n    \"only\": [\n      \"<string>\"\n    ],\n    \"order\": [\n      \"<string>\"\n    ],\n    \"strategy\": \"auto\"\n  },\n  \"time_range\": \"all\",\n  \"type\": \"web\"\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://api.agentkey.app/v2/ops/web.search")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"query\": \"<string>\",\n  \"country\": \"<string>\",\n  \"cursor\": \"<string>\",\n  \"exclude_domains\": [\n    \"<string>\"\n  ],\n  \"fields\": [\n    \"<string>\"\n  ],\n  \"include_domains\": [\n    \"<string>\"\n  ],\n  \"include_raw\": false,\n  \"lang\": \"<string>\",\n  \"limit\": 10,\n  \"provider\": \"<string>\",\n  \"routing\": {\n    \"allow_fallbacks\": true,\n    \"only\": [\n      \"<string>\"\n    ],\n    \"order\": [\n      \"<string>\"\n    ],\n    \"strategy\": \"auto\"\n  },\n  \"time_range\": \"all\",\n  \"type\": \"web\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.agentkey.app/v2/ops/web.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  \"query\": \"<string>\",\n  \"country\": \"<string>\",\n  \"cursor\": \"<string>\",\n  \"exclude_domains\": [\n    \"<string>\"\n  ],\n  \"fields\": [\n    \"<string>\"\n  ],\n  \"include_domains\": [\n    \"<string>\"\n  ],\n  \"include_raw\": false,\n  \"lang\": \"<string>\",\n  \"limit\": 10,\n  \"provider\": \"<string>\",\n  \"routing\": {\n    \"allow_fallbacks\": true,\n    \"only\": [\n      \"<string>\"\n    ],\n    \"order\": [\n      \"<string>\"\n    ],\n    \"strategy\": \"auto\"\n  },\n  \"time_range\": \"all\",\n  \"type\": \"web\"\n}"

response = http.request(request)
puts response.read_body

{
  "attempts": [
    {
      "provider": "<string>",
      "status": 123,
      "took_ms": 123,
      "tool": "<string>",
      "error_type": "<string>",
      "refunded": true,
      "upstream_status": 123
    }
  ],
  "credits_charged": 123,
  "data": {
    "items": [
      {
        "published_at": "2023-11-07T05:31:56Z",
        "site": "<string>",
        "snippet": "<string>",
        "title": "<string>",
        "url": "<string>"
      }
    ],
    "next_cursor": "<string>"
  },
  "op": "<string>",
  "op_version": 123,
  "provider": "<string>",
  "request_id": "<string>",
  "took_ms": 123,
  "unsupported_fields": [
    "<string>"
  ],
  "raw": "<unknown>",
  "raw_truncated": true
}

{
  "code": 123,
  "error": "<string>",
  "error_type": "<string>",
  "attempts": [
    {
      "provider": "<string>",
      "status": 123,
      "took_ms": 123,
      "tool": "<string>",
      "error_type": "<string>",
      "refunded": true,
      "upstream_status": 123
    }
  ],
  "op": "<string>",
  "request_id": "<string>"
}

{
  "code": 123,
  "error": "<string>",
  "error_type": "<string>",
  "attempts": [
    {
      "provider": "<string>",
      "status": 123,
      "took_ms": 123,
      "tool": "<string>",
      "error_type": "<string>",
      "refunded": true,
      "upstream_status": 123
    }
  ],
  "op": "<string>",
  "request_id": "<string>"
}

{
  "code": 123,
  "error": "<string>",
  "error_type": "<string>",
  "attempts": [
    {
      "provider": "<string>",
      "status": 123,
      "took_ms": 123,
      "tool": "<string>",
      "error_type": "<string>",
      "refunded": true,
      "upstream_status": 123
    }
  ],
  "op": "<string>",
  "request_id": "<string>"
}

{
  "code": 123,
  "error": "<string>",
  "error_type": "<string>",
  "attempts": [
    {
      "provider": "<string>",
      "status": 123,
      "took_ms": 123,
      "tool": "<string>",
      "error_type": "<string>",
      "refunded": true,
      "upstream_status": 123
    }
  ],
  "op": "<string>",
  "request_id": "<string>"
}

{
  "code": 123,
  "error": "<string>",
  "error_type": "<string>",
  "attempts": [
    {
      "provider": "<string>",
      "status": 123,
      "took_ms": 123,
      "tool": "<string>",
      "error_type": "<string>",
      "refunded": true,
      "upstream_status": 123
    }
  ],
  "op": "<string>",
  "request_id": "<string>"
}

{
  "code": 123,
  "error": "<string>",
  "error_type": "<string>",
  "attempts": [
    {
      "provider": "<string>",
      "status": 123,
      "took_ms": 123,
      "tool": "<string>",
      "error_type": "<string>",
      "refunded": true,
      "upstream_status": 123
    }
  ],
  "op": "<string>",
  "request_id": "<string>"
}

Overview

Scenario Methods

Catalog & Describe

Methods

Tool Catalog (MCP)

Authorizations

Body

Response