Skip to main content
POST
/
api
/
web
/
fetch
JavaScript
import { Hyperbrowser } from '@hyperbrowser/sdk';

const client = new Hyperbrowser({ apiKey: 'your-api-key' });

const response = await client.web.fetch({
  url: 'https://example.com',
  outputs: {
    formats: ['markdown', 'screenshot']
  }
});
{
  "jobId": "<string>",
  "status": "completed",
  "error": "<string>",
  "data": {
    "metadata": {},
    "html": "<string>",
    "markdown": "<string>",
    "links": [
      "<string>"
    ],
    "screenshot": "<string>",
    "json": {}
  }
}

Authorizations

x-api-key
string
header
required

Body

application/json
url
string
required
stealth
enum<string>
Available options:
none,
auto,
ultra
outputs
object
browser
object
navigation
object
cache
object

Response

Page fetched successfully

jobId
string
required
status
enum<string>
required
Available options:
completed,
failed,
pending,
running
error
string | null
data
object