Skip to main content
GET
/
browser
Content
curl --request GET \
  --url https://api.agentfirst.dev/browser \
  --header 'Authorization: Bearer <token>'
"<string>"

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
url
string
required

The URL of the page to browse; any unsafe characters require URL encoding.

Example:

"https://example.com/"

​
difficulty
enum<string>
default:low

The difficulty pool to attempt to access the URL from.

Available options:
low,
medium,
high (coming soon)
Example:

"low"

​
speed
enum<string>
default:light

The speed to attempt to access the URL at, where ridiculous is 30 percent faster on average than light speed.

Available options:
light,
ridiculous,
ludicrous (planned)
Example:

"light"

​
device
string

The name as returned by the devices resource of the device to emulate browsing on (these names are case insensitive but must include form- or URL-encoded spaces and punctuation marks); device emulation is unused by default.

Example:

null

​
ip
enum<string>

The type of IP address to browse from; a random IP type is used by default.

Available options:
residential,
isp,
datacenter (planned)
Example:

null

​
country
string

The two-letter ISO code of the country to browse 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 browse 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 browse from (these names are temporarily case sensitive and required to include form- or URL-encoded spaces and punctuation marks); a random city is used by default.

Example:

null

​
readiness
enum<string>
default:load

The standard ready event to await before snapshotting browsed content.

Available options:
load,
domcontentloaded
Example:

"load"

​
delay
number

The number of supplemental seconds to delay before snapshotting browsed content; no delay is used by default.

Required range: 0.1 <= x <= 10
Example:

null

​
format
enum<string>
default:rendered

The HTML format to output to.

Available options:
rendered,
raw
Example:

"rendered"

​
expiration
integer
default:1

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

Required range: 0 <= x <= 1
Example:

0

​
mode
enum<string>
default:sync

The synchronous or asynchronous mode of content retrieval (see the async resource).

Available options:
sync,
async
Example:

"sync"

Response

The page content.

The response is of type string.