Batch results

curl --request POST \
  --url https://api.agentfirst.dev/search/batches \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "terms": [
    "foo bar baz"
  ],
  "engine": "google",
  "serps": 1,
  "size": null,
  "offset": null,
  "device": null,
  "country": null,
  "subdivision": null,
  "city": null,
  "uule": null,
  "language": null,
  "display": null,
  "urls": [
    "https://www.google.com/search?q=foo+bar+baz&hl=fr&gl=fr&ie=UTF-8"
  ],
  "awaiting": "ai",
  "expiration": 0,
  "callback": "https://webhook.site/02e249f8-1faf-4fab-bcf5-78ce683e85a8"
}
'

import requests

url = "https://api.agentfirst.dev/search/batches"

payload = {
    "terms": ["foo bar baz"],
    "engine": "google",
    "serps": 1,
    "size": None,
    "offset": None,
    "device": None,
    "country": None,
    "subdivision": None,
    "city": None,
    "uule": None,
    "language": None,
    "display": None,
    "urls": ["https://www.google.com/search?q=foo+bar+baz&hl=fr&gl=fr&ie=UTF-8"],
    "awaiting": "ai",
    "expiration": 0,
    "callback": "https://webhook.site/02e249f8-1faf-4fab-bcf5-78ce683e85a8"
}
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({
    terms: ['foo bar baz'],
    engine: 'google',
    serps: 1,
    size: null,
    offset: null,
    device: null,
    country: null,
    subdivision: null,
    city: null,
    uule: null,
    language: null,
    display: null,
    urls: ['https://www.google.com/search?q=foo+bar+baz&hl=fr&gl=fr&ie=UTF-8'],
    awaiting: 'ai',
    expiration: 0,
    callback: 'https://webhook.site/02e249f8-1faf-4fab-bcf5-78ce683e85a8'
  })
};

fetch('https://api.agentfirst.dev/search/batches', 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.agentfirst.dev/search/batches",
  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([
    'terms' => [
        'foo bar baz'
    ],
    'engine' => 'google',
    'serps' => 1,
    'size' => null,
    'offset' => null,
    'device' => null,
    'country' => null,
    'subdivision' => null,
    'city' => null,
    'uule' => null,
    'language' => null,
    'display' => null,
    'urls' => [
        'https://www.google.com/search?q=foo+bar+baz&hl=fr&gl=fr&ie=UTF-8'
    ],
    'awaiting' => 'ai',
    'expiration' => 0,
    'callback' => 'https://webhook.site/02e249f8-1faf-4fab-bcf5-78ce683e85a8'
  ]),
  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.agentfirst.dev/search/batches"

	payload := strings.NewReader("{\n  \"terms\": [\n    \"foo bar baz\"\n  ],\n  \"engine\": \"google\",\n  \"serps\": 1,\n  \"size\": null,\n  \"offset\": null,\n  \"device\": null,\n  \"country\": null,\n  \"subdivision\": null,\n  \"city\": null,\n  \"uule\": null,\n  \"language\": null,\n  \"display\": null,\n  \"urls\": [\n    \"https://www.google.com/search?q=foo+bar+baz&hl=fr&gl=fr&ie=UTF-8\"\n  ],\n  \"awaiting\": \"ai\",\n  \"expiration\": 0,\n  \"callback\": \"https://webhook.site/02e249f8-1faf-4fab-bcf5-78ce683e85a8\"\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.agentfirst.dev/search/batches")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"terms\": [\n    \"foo bar baz\"\n  ],\n  \"engine\": \"google\",\n  \"serps\": 1,\n  \"size\": null,\n  \"offset\": null,\n  \"device\": null,\n  \"country\": null,\n  \"subdivision\": null,\n  \"city\": null,\n  \"uule\": null,\n  \"language\": null,\n  \"display\": null,\n  \"urls\": [\n    \"https://www.google.com/search?q=foo+bar+baz&hl=fr&gl=fr&ie=UTF-8\"\n  ],\n  \"awaiting\": \"ai\",\n  \"expiration\": 0,\n  \"callback\": \"https://webhook.site/02e249f8-1faf-4fab-bcf5-78ce683e85a8\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.agentfirst.dev/search/batches")

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  \"terms\": [\n    \"foo bar baz\"\n  ],\n  \"engine\": \"google\",\n  \"serps\": 1,\n  \"size\": null,\n  \"offset\": null,\n  \"device\": null,\n  \"country\": null,\n  \"subdivision\": null,\n  \"city\": null,\n  \"uule\": null,\n  \"language\": null,\n  \"display\": null,\n  \"urls\": [\n    \"https://www.google.com/search?q=foo+bar+baz&hl=fr&gl=fr&ie=UTF-8\"\n  ],\n  \"awaiting\": \"ai\",\n  \"expiration\": 0,\n  \"callback\": \"https://webhook.site/02e249f8-1faf-4fab-bcf5-78ce683e85a8\"\n}"

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

{
  "id": "a0482596-c2ad-445a-a435-727002156a20",
  "count": 1
}

"Authorization header must be provided"

"Credit balance is 0; top up at https://agentfirst.dev/#pricing"

"Valid API token must be provided"

"Character counts must be no more than 255"

"Unknown error occurred"

POST

batches

Batch results

curl --request POST \
  --url https://api.agentfirst.dev/search/batches \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "terms": [
    "foo bar baz"
  ],
  "engine": "google",
  "serps": 1,
  "size": null,
  "offset": null,
  "device": null,
  "country": null,
  "subdivision": null,
  "city": null,
  "uule": null,
  "language": null,
  "display": null,
  "urls": [
    "https://www.google.com/search?q=foo+bar+baz&hl=fr&gl=fr&ie=UTF-8"
  ],
  "awaiting": "ai",
  "expiration": 0,
  "callback": "https://webhook.site/02e249f8-1faf-4fab-bcf5-78ce683e85a8"
}
'

import requests

url = "https://api.agentfirst.dev/search/batches"

payload = {
    "terms": ["foo bar baz"],
    "engine": "google",
    "serps": 1,
    "size": None,
    "offset": None,
    "device": None,
    "country": None,
    "subdivision": None,
    "city": None,
    "uule": None,
    "language": None,
    "display": None,
    "urls": ["https://www.google.com/search?q=foo+bar+baz&hl=fr&gl=fr&ie=UTF-8"],
    "awaiting": "ai",
    "expiration": 0,
    "callback": "https://webhook.site/02e249f8-1faf-4fab-bcf5-78ce683e85a8"
}
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({
    terms: ['foo bar baz'],
    engine: 'google',
    serps: 1,
    size: null,
    offset: null,
    device: null,
    country: null,
    subdivision: null,
    city: null,
    uule: null,
    language: null,
    display: null,
    urls: ['https://www.google.com/search?q=foo+bar+baz&hl=fr&gl=fr&ie=UTF-8'],
    awaiting: 'ai',
    expiration: 0,
    callback: 'https://webhook.site/02e249f8-1faf-4fab-bcf5-78ce683e85a8'
  })
};

fetch('https://api.agentfirst.dev/search/batches', 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.agentfirst.dev/search/batches",
  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([
    'terms' => [
        'foo bar baz'
    ],
    'engine' => 'google',
    'serps' => 1,
    'size' => null,
    'offset' => null,
    'device' => null,
    'country' => null,
    'subdivision' => null,
    'city' => null,
    'uule' => null,
    'language' => null,
    'display' => null,
    'urls' => [
        'https://www.google.com/search?q=foo+bar+baz&hl=fr&gl=fr&ie=UTF-8'
    ],
    'awaiting' => 'ai',
    'expiration' => 0,
    'callback' => 'https://webhook.site/02e249f8-1faf-4fab-bcf5-78ce683e85a8'
  ]),
  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.agentfirst.dev/search/batches"

	payload := strings.NewReader("{\n  \"terms\": [\n    \"foo bar baz\"\n  ],\n  \"engine\": \"google\",\n  \"serps\": 1,\n  \"size\": null,\n  \"offset\": null,\n  \"device\": null,\n  \"country\": null,\n  \"subdivision\": null,\n  \"city\": null,\n  \"uule\": null,\n  \"language\": null,\n  \"display\": null,\n  \"urls\": [\n    \"https://www.google.com/search?q=foo+bar+baz&hl=fr&gl=fr&ie=UTF-8\"\n  ],\n  \"awaiting\": \"ai\",\n  \"expiration\": 0,\n  \"callback\": \"https://webhook.site/02e249f8-1faf-4fab-bcf5-78ce683e85a8\"\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.agentfirst.dev/search/batches")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"terms\": [\n    \"foo bar baz\"\n  ],\n  \"engine\": \"google\",\n  \"serps\": 1,\n  \"size\": null,\n  \"offset\": null,\n  \"device\": null,\n  \"country\": null,\n  \"subdivision\": null,\n  \"city\": null,\n  \"uule\": null,\n  \"language\": null,\n  \"display\": null,\n  \"urls\": [\n    \"https://www.google.com/search?q=foo+bar+baz&hl=fr&gl=fr&ie=UTF-8\"\n  ],\n  \"awaiting\": \"ai\",\n  \"expiration\": 0,\n  \"callback\": \"https://webhook.site/02e249f8-1faf-4fab-bcf5-78ce683e85a8\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.agentfirst.dev/search/batches")

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  \"terms\": [\n    \"foo bar baz\"\n  ],\n  \"engine\": \"google\",\n  \"serps\": 1,\n  \"size\": null,\n  \"offset\": null,\n  \"device\": null,\n  \"country\": null,\n  \"subdivision\": null,\n  \"city\": null,\n  \"uule\": null,\n  \"language\": null,\n  \"display\": null,\n  \"urls\": [\n    \"https://www.google.com/search?q=foo+bar+baz&hl=fr&gl=fr&ie=UTF-8\"\n  ],\n  \"awaiting\": \"ai\",\n  \"expiration\": 0,\n  \"callback\": \"https://webhook.site/02e249f8-1faf-4fab-bcf5-78ce683e85a8\"\n}"

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

{
  "id": "a0482596-c2ad-445a-a435-727002156a20",
  "count": 1
}

"Authorization header must be provided"

"Credit balance is 0; top up at https://agentfirst.dev/#pricing"

"Valid API token must be provided"

"Character counts must be no more than 255"

"Unknown error occurred"

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Option 1
Option 2

terms

string[]

required

The broad or exact words or phrases to query (e.g., foo bar baz or "foo bar baz").

Required array length: 1 - 1000 elements

Maximum string length: 255

Example:

["foo bar baz"]

engine

enum<string>

default:google

The search engine to use.

Available options:

google,

bing (coming soon)

Example:

"google"

serps

integer

default:1

The number of results pages to fetch.

Required range: 1 <= x <= 10

Example:

1

size

integer

The number of results per page to fetch; page size is unset by default.

Required range: 0 <= x <= 100

Example:

null

offset

integer

The number of initial results to skip; results aren’t offset by default.

Required range: 0 <= x <= 100

Example:

null

device

string

The name as returned by the devices resource [blocked] of the device to emulate searching on (these names are case insensitive); device emulation is unused by default.

Example:

null

country

string

The two-letter ISO code of the country to search from (these codes are case insensitive); a random country is used by default.

Example:

null

subdivision

string

The alphanumeric second part (proceeding the separator) of a first-level subdivision code in the (prerequisite) country to search from (these codes are case insensitive); a random subdivision is used by default.

Example:

null

city

string

The commonly spelled name of the city in the (prerequisite) country to search from (these names are temporarily case sensitive); a random city is used by default.

Example:

null

uule

string

The proprietary encoded string for emulating the location to search from; if possible, the actual location is searched from not emulated; location emulation is unused by default.

Example:

null

language

string

The commonly spelled name, two-letter ISO code, or Google code of the language to search in (these names and codes are case insensitive); the language is unset by default.

Example:

null

display

string

The commonly spelled name, two-letter ISO code, or Google code of the search interface’s display language (these names and codes are case insensitive); the display language is unset by default or set to the language if given.

Example:

null

urls

string<uri>[]

The URLs of the results pages to retrieve; if given, the URLs override any of the above params.

Required array length: 1 - 1000 elements

Maximum string length: 2047

Example:

[
  "https://www.google.com/search?q=foo+bar+baz&hl=fr&gl=fr&ie=UTF-8"
]

awaiting

enum<string>

The lazy result features to wait to load; any AI overview, which can take significant time to generate, is awaited for a maximum of 1 minute; multiple features can be provided by repeating the key; lazy results aren’t awaited by default.

Available options:

ai,

answers,

ads

Example:

"ai"

expiration

integer

default:1

The age in days of when to consider cached results expired, where 0 disables caching.

Required range: 0 <= x <= 1

Example:

0

callback

string

The HTTP or HTTPS callback URL or Amazon SQS queue URL or ARN to notify when the batch results have been retrieved; any SQS queue must grant sqs:SendMessage permission to the arn:aws:iam::180363035301:role/api-instance AWS principal.

Maximum string length: 2047

Example:

"https://webhook.site/02e249f8-1faf-4fab-bcf5-78ce683e85a8"

Response

A job identifier and confirmation count.

string<uuid>

required

The identifier to retrieve the batch searches with.

Example:

"a0482596-c2ad-445a-a435-727002156a20"

count

integer

required

The number of queries in the batch as confirmed by the API.

Required range: 1 <= x <= 1000

Example:

1

Introduction

Core API

Shared options

API management

For service providers

Batch results

Authorizations

Body

Response