POST
/
api
/
scrape
curl --request POST \
  --url https://app.agentgo.live/api/scrape \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "url": "https://example.com"
}'
{
  "success": true,
  "data": {
    "taskId": "927d98afdc99465b9017a4f931059c0e",
    "html": "<div class=\"content\">Example content</div>",
    "markdown": "# Example Page\n\nThis is an example page content...",
    "rawHtml": "<html><head>...</head><body><div class=\"content\">Example content</div></body></html>",
    "screenshot": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...",
    "links": [
      "https://example.com/page1",
      "https://example.com/page2",
      "/relative/path",
      "https://example.com/about",
      "https://example.com/contact"
    ],
    "imgs": [
      "https://example.com/image1.jpg",
      "https://example.com/image2.png",
      "/images/logo.png",
      "https://example.com/photos/banner.jpg",
      "/assets/icons/favicon.ico"
    ]
  }
}

Authorizations

x-api-key
string
headerrequired

API key obtained from your AgentGo dashboard

Body

application/json
url
string
required

URL of the webpage to scrape. Must be a valid, publicly accessible URL.

formats
enum<string>[]

Output formats to return. If not specified, defaults to ['html'].

Available options:
markdown,
html,
rawHtml,
screenshot
timeout
integer
default: 30000

Timeout in milliseconds for the scraping operation. Minimum 1000ms, maximum 60000ms.

Response

200 - application/json
success
boolean
required

Indicates if the request was successful

data
object
required
API Overview